Skip to content

Fix ReadTheDocs warnings#863

Merged
Bachibouzouk merged 7 commits intodevfrom
fix/RTD-warnings
Apr 16, 2021
Merged

Fix ReadTheDocs warnings#863
Bachibouzouk merged 7 commits intodevfrom
fix/RTD-warnings

Conversation

@Bachibouzouk
Copy link
Copy Markdown
Collaborator

@Bachibouzouk Bachibouzouk commented Apr 16, 2021

Changes proposed in this pull request:

  • Turn warnings into errors when building RTD so that no one can mess the documentation and get away with it :)
  • Add a function generate_kpi_description in docs/conf.py module to generate documentation of kpi parameters listed in docs/MVS_kpis_list.csv

The following steps were realized, as well (if applies):

  • Use in-line comments to explain your code
  • Write docstrings to your code (example docstring)
  • Update the CHANGELOG.md
  • Apply black (black . --exclude docs/)

For more information on how to contribute check the CONTRIBUTING.md.

@Bachibouzouk Bachibouzouk merged commit e669938 into dev Apr 16, 2021
@Bachibouzouk Bachibouzouk deleted the fix/RTD-warnings branch April 16, 2021 09:49
@smartie2076 smartie2076 mentioned this pull request May 31, 2021
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.

1 participant