-
Notifications
You must be signed in to change notification settings - Fork 18
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
Documentation restructurization and fixes #93
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice changes! The documentation looks a bit cleaner.
I have done a few more things:
- Fixed a small warning linked to the
installation.rst
file, - Commented out
html_static_path
inconf.py
as we do not have any custom static files to serve yet (e.g. style sheets etc), - Added an
intersphinx
link to the matplotlib doc, so we'll be able to link classes like
:py:class:
matplotlib.figure.Figure
- Commented out
make html
indoc_build.sh
as we actually do not need this command.readthedocs
does not use anymake
file to build the doc, only thesphinx-build
command (you can check the commands used during a build here.
So I would go even further and delete the filemake.bat
andMakefile
indocs/
as we do not need them. I would also argue that the script used to locally build the doc should mimic as close as possiblereadthedocs
and thus do not rely onmake
.
These tiny fixes removed the remaining warnings, except for one:
WARNING: Duplicate ID: "module-miprometheus.problems".
I am pretty sure this is caused by problems.rst
, as it contains the following directive twice:
.. automodule:: miprometheus.problems
See this post on stackoverflow.
Hence the duplicate
warning. Removing the second line causes the build to fail, so we shouldn't. I would leave this warning as is for now.
Restructured the documentation, fixing errors and warnings