Skip to content

Add rtd file for requirements#590

Merged
smartie2076 merged 7 commits intodevfrom
documentation/requirements
Oct 7, 2020
Merged

Add rtd file for requirements#590
smartie2076 merged 7 commits intodevfrom
documentation/requirements

Conversation

@smartie2076
Copy link
Copy Markdown
Collaborator

Adresses #532

Changes proposed in this pull request:

  • Added E-Land_Requirements.rst: Official E-Land requirement list as well as progress on functional and non-functional requirements
  • Changed order of readthedocs content

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)

@smartie2076 smartie2076 added the documentation Improvements or additions to documentation label Oct 5, 2020
@smartie2076 smartie2076 self-assigned this Oct 5, 2020
@smartie2076 smartie2076 changed the title Documentation/requirements Add rtd file for requirements Oct 5, 2020
@smartie2076 smartie2076 merged commit 5eab0ff into dev Oct 7, 2020
@smartie2076 smartie2076 deleted the documentation/requirements branch October 7, 2020 08:57
@smartie2076
Copy link
Copy Markdown
Collaborator Author

I have merged this now so that we can check it in the monthly meeting.

@smartie2076 smartie2076 mentioned this pull request Nov 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant