Documenting a plugin¶

If you used the AiiDA plugin cutter, your plugin already comes with a basic documentation that just needs to be adjusted to your needs.

  1. Install the docs extra:

    pip install -e .[docs]
    
  2. Populate, delete, or add to the individual documentation pages:

    docs/source/index.rst
    docs/source/module_guide/index.rst
    docs/source/user_guide/index.rst
    docs/source/user_guide/get_started.rst
    docs/source/user_guide/tutorial.rst
    
  3. Use Sphinx to generate the html documentation:

    cd docs
    make
    

    Check the result by opening build/html/index.html in your browser.

  4. Host your documentation online on ReadTheDocs. Simply sign up and import your project. Make sure to add the path to the requirements file docs/requirements_for_rtd.txt and the Python configuration file docs/source/conf.py in Admin => Advanced settings.

Note: When updating the plugin to a new version, remember to update the version number both in setup.json and aiida_mycode/__init__.py.