Fix/improve documentation#5
Draft
PhilippRue wants to merge 17 commits intodevelopfrom
Draft
Conversation
Member
Author
|
So far the readthedocs docu does not give the auto generated API reference, to build this locally go to the docs directory and run TODO: A comparison to the docu settings of aiida-kkr or aiida-fleur should allow us to fix this issue. |
# Conflicts: # aiida_jutools/__init__.py # docs/source/conf.py # docs/source/index.rst # docs/source/module_guide/index.rst
Member
|
With regard to this pull request, I'm rebasing the project config files on the aiida-plugin-cutter template. Motivation: 1) have config up to date, no outdated stuff, 2) have AiiDA-integrated testing set up correctly. This is happening in the branch fix_docs_cookiecutter. Will finish this in June-July.
|
This file contains hidden or 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
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.
Make readthedocs documentation work and improve the documentation of the package's features
Until this is merged the docs for this branch are availabe under: https://aiida-jutools.readthedocs.io/en/fix_docs/