-
Notifications
You must be signed in to change notification settings - Fork 70
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
Improve documentation #560
Conversation
define order from toctree
fix ref
fix link-type
…ot-showing-statistics-table-in-pastasplotsseries' into 545-enhancement-improve-readthedocs
fix names
Coverage summary from CodacyMerging #560 (818c0c5) into
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
Some nice additions, but also some new errors .. ;-) Not a big fan of all the manual linking to rst files and notebooks. Why is this better? This is prone to errors, multiple links are already not working now because of this: https://pastas--560.org.readthedocs.build/en/560/examples/index.html A possible fix would be to implement nblink or some url checker. Also, there are new warnings given by ReadTheDocs that should be fixed first. |
update underline
Now if you remove notebook
you have to rename:
With this change, you can simply adjust the |
Should all be good now. |
25e0033
to
f8aa89b
Compare
I hope you wrote a script to write that comment ;-) I can see your point. |
checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/pastas/checkouts/560/doc/examples/diagnostic_checking.ipynb: WARNING: document isn't included in any toctree |
Perhaps ReadTheDocs should throwing errors when these kind of things come up somehow. Now we have to manually check for errors in the built process to uncover this. |
👼 . |
Agree |
Fixed this, should be good now. |
Nice work. Merging. |
Short Description
Checklist before PR can be merged: