diff --git a/.gitignore b/.gitignore index 1d9cc9b..6dcc268 100644 --- a/.gitignore +++ b/.gitignore @@ -224,3 +224,5 @@ tags # End of https://www.gitignore.io/api/vim,python,pycharm .DS_Store +.vscode/ +_build/ diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..c678536 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,10 @@ +version: 2 + +python: + version: "3.8" + install: + - requirements: doc_requirements.txt + +sphinx: + builder: html + fail_on_warning: true diff --git a/000_aep_guidelines/readme.md b/000_aep_guidelines/readme.md index 7f3bc1d..db5c6e9 100644 --- a/000_aep_guidelines/readme.md +++ b/000_aep_guidelines/readme.md @@ -74,7 +74,7 @@ A summary for pros and cons for the proposed enhancement, detailing e.g. which p and put readme file in [Markdown](https://guides.github.com/features/mastering-markdown/) format inside this folder. * You may use this `readme.md` as a template. * You may use the folder to include additional files relevant to your enhancement proposal. - * Add your AEP to the `README.md` at the top level of the repository. + * Add your AEP to the `README.md` and `_toc.yml` files at the root of the repository. * Consider discussing your proposal informally with an [AiiDA team](https://github.com/orgs/aiidateam/people) member to get an initial reaction and, potentially, another champion for your proposal. 3. Commit your changes and submit a [pull request](https://help.github.com/en/articles/creating-a-pull-request) to the AEP repository diff --git a/README.md b/README.md index f617710..2fd747f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # AiiDA Enhancement Proposals (AEPs) -This repository contains enhancement proposals for [AiiDA](www.aiida.net) (AiiDA +This repository contains enhancement proposals for [AiiDA](https://www.aiida.net) (AiiDA enhancement proposals = AEPs), similar to [PEPs](https://www.python.org/dev/peps/) of the python core language but less 'formalized' and closer to the way the [Jupyter project deals @@ -9,18 +9,18 @@ with enhancement proposals](https://github.com/jupyter/enhancement-proposals). The purpose is to publicly discuss new features & design choices in the AiiDA ecosystem and to document the decision making process. - -## Index of AEPs +## Index of AEPs | Number | Status | Title | |--------|------------------|------------------------------------------------------------------| | 000 | active | [AEP guidelines](000_aep_guidelines/readme.md) | -| 001 | implemented | [Drop support for Python 2.7](001_drop_python2/) | -| 002 | implemented | [AiiDA Dependency Management](002_dependency_management/) | -| 003 | active | [Adopt NEP 29](003_adopt_nep_29/) | -| 004 | implemented | [Infrastructure for importing completed `CalcJob`s](004_calcjob_importer/) | -| 005 | draft | [New Export Format](005_exportformat/) | -| 006 | implemented | [Efficient object store for the AiiDA repository](006_efficient_object_store_for_repository/) | +| 001 | implemented | [Drop support for Python 2.7](001_drop_python2/readme.md) | +| 002 | implemented | [AiiDA Dependency Management](002_dependency_management/readme.md) | +| 003 | active | [Adopt NEP 29](003_adopt_nep_29/readme.md) | +| 004 | implemented | [Infrastructure for importing completed `CalcJob`s](004_calcjob_importer/readme.md) | +| 005 | draft | [New Export Format](005_exportformat/readme.md) | +| 006 | implemented | [Efficient object store for the AiiDA repository](006_efficient_object_store_for_repository/readme.md) | ## Submitting an AEP -The submission process is described in the [AEP guidelines](000_aep_guidelines/readme.md) which also act as a template for new AEPs. + +The submission process is described in the [AEP guidelines](000_aep_guidelines/readme.md) which also act as a template for new AEPs. diff --git a/_toc.yml b/_toc.yml new file mode 100644 index 0000000..c661e59 --- /dev/null +++ b/_toc.yml @@ -0,0 +1,11 @@ +root: README.md +subtrees: +- caption: Proposals + entries: + - file: 000_aep_guidelines/readme.md + - file: 001_drop_python2/readme.md + - file: 002_dependency_management/readme.md + - file: 003_adopt_nep_29/readme.md + - file: 004_calcjob_importer/readme.md + - file: 005_exportformat/readme.md + - file: 006_efficient_object_store_for_repository/readme.md diff --git a/conf.py b/conf.py new file mode 100644 index 0000000..71f561b --- /dev/null +++ b/conf.py @@ -0,0 +1,10 @@ +"""Sphinx configuration file.""" + +project = html_title = "AiiDA Enhancement Proposals" +author = "The AiiDA team" + +extensions = ["myst_parser", "sphinx_external_toc"] +exclude_patterns = [".github", ".tox", ".vscode", "_build"] +external_toc_exclude_missing = True +html_theme = "furo" +suppress_warnings = ["myst.header"] diff --git a/doc_requirements.txt b/doc_requirements.txt new file mode 100644 index 0000000..02584ce --- /dev/null +++ b/doc_requirements.txt @@ -0,0 +1,3 @@ +myst-parser~=0.16.0 +sphinx-external-toc~=0.2.3 +furo==2021.11.23 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..51e11f2 --- /dev/null +++ b/tox.ini @@ -0,0 +1,13 @@ +[tox] +envlist = docs-clean + +[testenv:docs-{update,clean}] +skip_install = true +deps = -rdoc_requirements.txt +whitelist_externals = + rm + echo +commands = + clean: rm -rf docs/_build + sphinx-build -nW --keep-going -b {posargs:html} . _build/{posargs:html} +commands_post = echo "open file://{toxinidir}/_build/{posargs:html}/index.html"