Skip to content

Fix readthedoc for code modules#564

Merged
Bachibouzouk merged 7 commits intodevfrom
fix/readthedoc_code
Sep 16, 2020
Merged

Fix readthedoc for code modules#564
Bachibouzouk merged 7 commits intodevfrom
fix/readthedoc_code

Conversation

@Bachibouzouk
Copy link
Copy Markdown
Collaborator

Fix #563

Changes proposed in this pull request:

  • Change the import path of the modules for automatic docstrings import in docs/Code.rst
  • Fix the docstrings with math expressions (need to add r before the """ of the docstring)

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

  • For new functionalities: Explain in readthedocs
  • Update the CHANGELOG.md

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

Copy link
Copy Markdown
Collaborator

@smartie2076 smartie2076 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docstrings of the report are not included in code.rst yet.

@Bachibouzouk Bachibouzouk merged commit 0dd941f into dev Sep 16, 2020
@Bachibouzouk Bachibouzouk deleted the fix/readthedoc_code branch September 16, 2020 07:37
@smartie2076 smartie2076 mentioned this pull request Sep 21, 2020
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.

[Documentation] False paths in Code.rst

2 participants