The primary website for AiiDA.
Clone this repository and create a new branch.
Then, either run python create_post.py -h
or follow the steps manually:
docs/news/posts
, named by the date and keyword.docs/events.yaml
file.Finally, create a PR to this repository.
The top-matter category
should be one of the following:
News
: To announce a general newsEvents
: To announce an eventReports
: To report on an eventRelease
: To announce a new releaseBlog
: A blog postYou can use the update directive to note an update to an existing post.
Use the subfigure directive, to arrange multiple images in a figure.
Install and run tox
to install a local virtual environment and build the documentation,
or directly install requirements.txt
and run: sphinx-build -nW --keep-going -b html docs/ docs/_build/html
.
To check HTML links, run tox -e linkcheck
or sphinx-build -b linkcheck docs/ docs/_build/linkcheck
.
postlist
placeholderblog_post_pattern
?