DOC: improve docs before v1 #386
Merged
Conversation
This file contains hidden or 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
- This was made to improve docs pages - The main change was related to the different toctree
Member
Author
|
Reference: https://peps.python.org/pep-0440/ |
Member
Author
|
1st July - 18:56 : Right now I'm getting 560 warnings when building the documentation |
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Member
Author
|
@phmbressan can you review this one please? Remember the steps to create the docs pages: cd docs
pip install -r requirements.txt
make htmlpandoc is also a requirement. |
giovaniceotto
approved these changes
Jul 3, 2023
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.
We need to update our documentation page before the pre-release.
This will run really fast tho, just some quick TO-DOs below.
Remaining tasks:
For Future PRs: