Skip to content
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

New sphinx theme needs to be chosen #377

Closed
bwohlberg opened this issue Feb 2, 2023 · 1 comment · Fixed by #418
Closed

New sphinx theme needs to be chosen #377

bwohlberg opened this issue Feb 2, 2023 · 1 comment · Fixed by #418
Assignees
Labels
documentation Improvements or additions to documentation priority: low Low priority

Comments

@bwohlberg
Copy link
Collaborator

The current sphinx theme is faculty-sphinx-theme, which does not handle icons and favicons correctly for sphinx >= 6.0. This is presumably because it requires version 0.4.3 of sphinx-rtd-theme, the current release of which is 1.1.1. Since faculty-sphinx-theme has not been modified for well over a year, it seems unlikely that the sphinx-rtd-theme dependency version will be updated.

@bwohlberg bwohlberg added documentation Improvements or additions to documentation priority: low Low priority labels Feb 2, 2023
@tbalke tbalke self-assigned this Apr 11, 2023
@lanl lanl deleted a comment from tbalke Apr 11, 2023
@bwohlberg
Copy link
Collaborator Author

When changing the theme, the version pinning of docutils in docs/docs_requirements.txt should be removed or replaced with a lower bound, since the current setting is complicating conda version resolution for python 3.10. The pinning was introduced to address this issue.

@bwohlberg bwohlberg mentioned this issue May 13, 2023
Michael-T-McCann pushed a commit that referenced this issue May 19, 2023
* Resolve #261 (#416)

* Improve markup for numpy.float32 etc. as well as some other docs improvements

* Add note to style docs

* Minor docs edit

* Some markup changes

* Resolve #165 (#415)

* Add function for computing gaussian distribution

* Typing fix and better default sigma

* Address #165

* Fix docs typos and suppress apparently-spurious type error

* Target clean also cleans _autosummary directory

* Use new TypeAlias declaration

* Suppress type error

* Avoid pollution of docs with excessively long type alias definition

* Add comment as per PR review suggestion

* Resolve #83 (#417)

* Attempt to remove rtd edit on github button

* Bump jaxlib/jax max versions

* Remove function no longer in jax.numpy

* Resolve #377 (#418)

* Fix markup

* Docstring edits

* Change sphinx theme

* Docstring fixes

* Theme customization

* Clean up

* Fix inheritance diagram insertion

* Resolve document not in any toctree warning for index.ipynb

* Clean up

* Update submodule

* Adjust css

* Avoid problems with dark mode

* Add version number in sidebar

* Change inheritance diagram color scheme

* Clean up

* Correct path to docs_requirements

---------

Co-authored-by: Thilo Balke <thilo.balke@gmail.com>

* Implement PR review recommendations

---------

Co-authored-by: Thilo Balke <thilo.balke@gmail.com>
Michael-T-McCann added a commit that referenced this issue May 19, 2023
* Rename test file

* Add function and tests

* Replace try-and-see code with new function

* Implement #419 review recommendations (#421)

* Resolve #261 (#416)

* Improve markup for numpy.float32 etc. as well as some other docs improvements

* Add note to style docs

* Minor docs edit

* Some markup changes

* Resolve #165 (#415)

* Add function for computing gaussian distribution

* Typing fix and better default sigma

* Address #165

* Fix docs typos and suppress apparently-spurious type error

* Target clean also cleans _autosummary directory

* Use new TypeAlias declaration

* Suppress type error

* Avoid pollution of docs with excessively long type alias definition

* Add comment as per PR review suggestion

* Resolve #83 (#417)

* Attempt to remove rtd edit on github button

* Bump jaxlib/jax max versions

* Remove function no longer in jax.numpy

* Resolve #377 (#418)

* Fix markup

* Docstring edits

* Change sphinx theme

* Docstring fixes

* Theme customization

* Clean up

* Fix inheritance diagram insertion

* Resolve document not in any toctree warning for index.ipynb

* Clean up

* Update submodule

* Adjust css

* Avoid problems with dark mode

* Add version number in sidebar

* Change inheritance diagram color scheme

* Clean up

* Correct path to docs_requirements

---------

Co-authored-by: Thilo Balke <thilo.balke@gmail.com>

* Implement PR review recommendations

---------

Co-authored-by: Thilo Balke <thilo.balke@gmail.com>

---------

Co-authored-by: Brendt Wohlberg <bwohlberg@users.noreply.github.com>
Co-authored-by: Thilo Balke <thilo.balke@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority: low Low priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants