Skip to content

chore: remove nbsphinx link and use the pydata theme to render our documentation #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

zmx27
Copy link

@zmx27 zmx27 commented Aug 4, 2025

No description provided.

@zmx27
Copy link
Author

zmx27 commented Aug 4, 2025

@sbillinge this is ready for review. This also addresses the error that vince ran into at the following comment:
#66 (comment)

Done in collaboration with @ycexiao

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks good. couple of small comments

@@ -64,7 +72,7 @@
source_suffix = [".rst", ".md"]

# The encoding of source files.
# source_encoding = 'utf-8-sig'
# source_encoding = eutf-8-sig'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this intended?

@@ -134,7 +142,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets comment out sphinx_rtd_theme in case we want to go back some time

@zmx27
Copy link
Author

zmx27 commented Aug 5, 2025

@sbillinge ready for review

@sbillinge
Copy link
Contributor

great work getting to the bottome of this! Thanks so much.

@sbillinge sbillinge merged commit 20799ab into diffpy:migration Aug 5, 2025
2 checks passed
@sbillinge
Copy link
Contributor

readthedocs successfully built the docs now, but they are not rendering correctly for some reason. It almost looks like they are rendering an older version. @zmx27, @ycexiao please could you look into it and see what you can come up with?

@vincefn
Copy link
Collaborator

vincefn commented Aug 5, 2025

Docs are well rendered on https://pyobjcryst.readthedocs.io/en/migration/. Nice. Interesting to see how you got rid of nbsphinx_lnk.

What I can see:

  • the QPA notebook is not listed
  • Can the "Getting started" part be removed or updated - it seems like a template for docs - that's not where we want people to start with pyobjcryst ?
  • the release notes are not up-to-date
  • main page says "no version found" - not sure what the mechanism is to find it.

Cheers,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants