Resolve docstring errors and transition to MkDocs #34
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
Should speed up the readthedocs build. I can't test this configuration since I don't have access to the readthedocs account though.
tested locally using [act](https://www.freecodecamp.org/news/how-to-run-github-actions-locally/)
MitchellAcoustics
changed the title
MitchellAcoustics
added
bug
|
This pull request is just to get the work onto the upstream repo, rather than my fork. |
MitchellAcoustics
merged commit a943acb
into
Universite-Gustave-Eiffel:23-invalid-escape-sequences-in-docstrings
1 of 2 checks passed
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.
Transitioning to mkdocs for documentation.
At current stage 7d116d0, the mkdocs is configured, and some pages and docstrings have been converted.
Ongoing work is to continue converting docstrings, then integrate jupyter notebooks, then reexamine the layout and organisation of the docs