Skip to content

Decrease RTD warnings #693

Merged
smartie2076 merged 13 commits intodevfrom
fix/readthedocs_warnings
Dec 9, 2020
Merged

Decrease RTD warnings #693
smartie2076 merged 13 commits intodevfrom
fix/readthedocs_warnings

Conversation

@smartie2076
Copy link
Copy Markdown
Collaborator

@smartie2076 smartie2076 commented Dec 8, 2020

Fix #688

Changes proposed in this pull request:

  • Decreased RTD compilation warnings
  • Version number of MVS is automatically used in RTD

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

  • Use in-line comments to explain your code
  • Write docstrings to your code (example docstring)
  • For new functionalities: Explain in readthedocs
  • Write test(s) for your new patch of code (pytests, assertion debug messages)
  • Update the CHANGELOG.md
  • Apply black (black . --exclude docs/)
  • Check if benchmark tests pass locally (EXECUTE_TESTS_ON=master pytest)

@mahendrark mahendrark force-pushed the fix/readthedocs_warnings branch from 4e61124 to 35b3b03 Compare December 8, 2020 20:21
- … now as ...
- “type_oemof” to `type_oemof`
- Replaced € with Euro or currency
- Replace ‘ by `
- Replace `True’ by `True`
- Rewriting to avoid unparsable letters
- Replace apostrope ’ by '
use `name <link>`__ instead of `name <link>`_
as per sphinx-doc/sphinx#3921
@smartie2076
Copy link
Copy Markdown
Collaborator Author

Hi @mahendrark! What did you force-push into this PR yesterday? Usually, it would be better to create an own branch which then merges into an existing PR if you want to add own changes.

@mahendrark
Copy link
Copy Markdown
Contributor

Hi @mahendrark! What did you force-push into this PR yesterday? Usually, it would be better to create an own branch which then merges into an existing PR if you want to add own changes.

@smartie2076 , I did not add any changes, just rebased the branch after Sabine merged the last PR. PF taught me to use this technique instead of just merging dev into current branch, when merge conflicts arise.

@smartie2076
Copy link
Copy Markdown
Collaborator Author

Hi @mahendrark! What did you force-push into this PR yesterday? Usually, it would be better to create an own branch which then merges into an existing PR if you want to add own changes.

@smartie2076 , I did not add any changes, just rebased the branch after Sabine merged the last PR. PF taught me to use this technique instead of just merging dev into current branch, when merge conflicts arise.

Hmhm, I had to overwrite your rebase as it removed my commits. Weird...

@smartie2076
Copy link
Copy Markdown
Collaborator Author

Also weird: When I execute make html I have 16 warnings the first time around, and 0 the second time around. I dont know why that happens.

@smartie2076 smartie2076 marked this pull request as ready for review December 9, 2020 12:13
@mahendrark
Copy link
Copy Markdown
Contributor

mahendrark commented Dec 9, 2020

Also weird: When I execute make html I have 16 warnings the first time around, and 0 the second time around. I dont know why that happens.

oh yeah I experienced this as well when working on open_plan

@Bachibouzouk told me that the compiler or whatever it is that checks the formatting is "smart". So unless you make changes and run it, it wont show you the warnings/errors again if you run make html immediately without changing code

the errors will still be there! This drove me crazy some time ago :/

@mahendrark
Copy link
Copy Markdown
Contributor

Hi @mahendrark! What did you force-push into this PR yesterday? Usually, it would be better to create an own branch which then merges into an existing PR if you want to add own changes.

@smartie2076 , I did not add any changes, just rebased the branch after Sabine merged the last PR. PF taught me to use this technique instead of just merging dev into current branch, when merge conflicts arise.

Hmhm, I had to overwrite your rebase as it removed my commits. Weird...

oh-oooh
I have no idea what happened. I rebased like how I do normally on every branch.
I do remember that I saw only commit when I opened this PR for reviewing. Just the one "Use version number in RTD ". That why it has me as co-author.. strange indeed.

@mahendrark
Copy link
Copy Markdown
Contributor

I will run make html on this branch and post how many warnings/errors I run into

@smartie2076
Copy link
Copy Markdown
Collaborator Author

I will run make html on this branch and post how many warnings/errors I run into

Great, thanks!

@mahendrark
Copy link
Copy Markdown
Contributor

@smartie2076

I have 16 errors still when I run make html. I guess you can merge it and I can add the task of fixing them to #646 because it is dealing with RTD anyway

@smartie2076
Copy link
Copy Markdown
Collaborator Author

@smartie2076

I have 16 errors still when I run make html. I guess you can merge it and I can add the task of fixing them to #646 because it is dealing with RTD anyway

That would be perfect, thank you! I also think that my PC is buggy in the compilation of those errors. I wonder if there is also a pytest that can check that the RTD compilation runs though without any errors/warnings, so that we can make sure that we never again have to deal with that many bugs at once...

@smartie2076 smartie2076 merged commit 06f6aa1 into dev Dec 9, 2020
@smartie2076 smartie2076 deleted the fix/readthedocs_warnings branch December 9, 2020 13:32
@smartie2076
Copy link
Copy Markdown
Collaborator Author

I have 16 errors still when I run make html.

Note: The warnings regarding autosummary are fixed for me after the second code execution. The changes in conf.py are the ones that should have fixed them...

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.

[Bug] A lot of warnings while compiling read the docs

2 participants