[MRG] Change Sphinx theme (and fix minor typos) #971
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
asoplata
force-pushed
the
rebuild-sphinx-pyramids
branch
from
b85b222 to
1a57237
Compare
|
Whoops, forgot to first rebase against current master. Should be up-to-date now. |
|
@asoplata can you share how the new website looks on your fork of jonescompneuro.github.io/hnn-core/ ? |
|
Note that, since I fixed the (working version dropdown shown) (working search shown) (successfully-run simulations shown) (autobuilt docs part shown) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes a big visual change to the "Code Website" at https://jonescompneurolab.github.io/hnn-core/stable/index.html , whereby it changes the theme from the unmaintained
sphinx-bootstrap-themeto the actively maintained and popularpydata-sphinx-theme. The first commit also fixes some typos currently present in the documentationMakefile. This is part of the changes organized in #969.This resolves #941 because search is provided entirely by the theme; this also enables us to remove
doc/_templates/search.html.This resolves #908 because version-hyperlinking is supported by the theme too, enabling us to remove
doc/_templates/navbar.html. Instead, in the future, versions will need to be specific indoc/_static/versions.json.A note about the versioning system: the PyData theme insists that the file your versioning metadata "...needs to be at a stable, persistent, fully-resolved URL" ( https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/version-dropdown.html#configure-switcher-json-url ). Thus, currently in this PR, the
versions.jsonURL is set to point to an existing file I manually added to thegh-pagesbranch for the stable version, accessible here: https://jonescompneurolab.github.io/hnn-core/stable/_static/versions.json ( new code using this resource is located here: b85b222#diff-e170e9a7d787c21095c6c11bb25f0f1ff0294a42a46d45ba6fb5ed794e457624R105 ). AFTER this PR is merged, 3 things will happen:masterbranch will then contain its own local copy ofdoc/_static/versions.json.devversion of the website, which will then cause this new file to be located athttps://jonescompneurolab.github.io/hnn-core/dev/_static/versions.json. This is the "version" of the "version file" that we should use after this point (which is what other theme users do).doc/conf.pyto link to the "dev" version of our "version file". After this point, anytime there is a new version, one will only need to update themasterbranch's copy of the version file, and then it will be propagated.