doc: change style of documentation #543
Merged
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
Contributor
wd15
commented
Mar 11, 2021
•
wd15
commented
- improve look and feel of the docs
- switch to alabaster style
- use sidebar rather than navbar
- make sfepy documentation work without sfepy installed for readthedocs
- failed test has been fixed on another PR
|
Failed test is because of an issue that's been fixed in another PR. |
Change style of docs from bootstrap to alabaster. Clean up and simplify overall. Make the notebooks work correctly as part of the table of contents by including in a rst file rather than using index.ipynb as the main notebook index file. Also, stop using mock to allow solve_fe docs. The solve_fe function can now be imported without sfepy being required so remove all the mock paraphernalia from conf.py.
Allow solve_fe to display its documentation without having to import sfepy.
wd15
requested review from
auag92,
beyucel,
faical-yannick-congo and
SvenPVoigt
Remove elasticity.ipynb from circle tests as the load is often too much for Circle.
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.