Skip to content
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

Merged
merged 14 commits into from
Nov 15, 2018

Conversation

tkornuta-ibm
Copy link
Contributor

Restructured the documentation, fixing errors and warnings

Copy link
Contributor

@vmarois vmarois left a 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 in conf.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 in doc_build.sh as we actually do not need this command. readthedocs does not use any make file to build the doc, only the sphinx-build command (you can check the commands used during a build here.
    So I would go even further and delete the file make.bat and Makefile in docs/ as we do not need them. I would also argue that the script used to locally build the doc should mimic as close as possible readthedocs and thus do not rely on make.

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.

@vmarois vmarois merged commit 59d4419 into develop Nov 15, 2018
@vmarois vmarois deleted the doc/reformatting_and_fixes branch November 15, 2018 17:42
@vmarois vmarois mentioned this pull request Nov 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants