Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/improve documentation #5

Draft
wants to merge 17 commits into
base: develop
Choose a base branch
from
Draft

Fix/improve documentation #5

wants to merge 17 commits into from

Conversation

PhilippRue
Copy link
Member

@PhilippRue PhilippRue commented Feb 17, 2021

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/

@PhilippRue
Copy link
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 make html where the API reference is included.

TODO: A comparison to the docu settings of aiida-kkr or aiida-fleur should allow us to fix this issue.

@Irratzo Irratzo self-requested a review May 11, 2021 15:51
# Conflicts:
#	aiida_jutools/__init__.py
#	docs/source/conf.py
#	docs/source/index.rst
#	docs/source/module_guide/index.rst
@Irratzo
Copy link
Member

Irratzo commented Jun 5, 2021

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.

  • rebase project config files on aiida-plugin-cutter template
  • adjust config files until everything works (setup, Actions, docs, ..., optional: PyPI Action)
  • merge into fix_docs branch
  • fix docs: base structure skeleton on hitchhiker, implemented example: DScribe docs (all sections empty).
  • fix docs: complete API section (autodoc, missing class docstrings, etc.), until RTD page looks good.
  • (take care that ruess' earlier refactoring of roman's test files are not lost)
  • merge into develop branch (optional: merge develop into master branch)
  • close pull request

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.

None yet

2 participants