Docs: Add developer documentation and fix bugs #134
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
niketagrawal
commented
Jul 12, 2023
niketagrawal
commented
- Developer documentation first draft: Domain decomposition, developer guidelines, unit tests
- Video on home page
- Fixes for missing references
Build fixes to documentation
* remove reference to old branch * update insallaiton instruction in docs * update intallation file in docs * fix reference to equilibrium equation * include python 3.11 in CI * add note on Windows installation
* remove reference to old branch * update insallaiton instruction in docs * update intallation file in docs * fix reference to equilibrium equation * include python 3.11 in CI * add note on Windows installation * fixe bibtype issues * include bibliography in separated file * remove youtube extension
…pt implementation (#127) * Fix typo. Specify minimum version of the Sphinx bibliography extension * Update domain_decomposition.rst Some small textual changes --------- Co-authored-by: Sierd <Sierd.deVries@tudelft.nl>
* change author and CR to Aeolis team * frix wrong version for bibtex extension * include AeoLiS in requirements.txt * move quicstart to developer directory * write documentation for quickstart * update location of quickstart for developers * add reference lavel for installation section * fix malform code block * rename RST file for unit tests * add warning to quickstart.rst * first draft for unit testing section * change recomendation to Numpy docstrings --------- Co-authored-by: Niket Agrawal <15953349+niketagrawal@users.noreply.github.com>
niketagrawal
changed the title
niketagrawal
changed the title
This was referenced Jul 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.