This repo contains the source code (i.e. the plain-text) of the iAM.AMR Documentation site hosted by Read the Docs.
For more details, see the Documentation section section of the documentation site.
The recommended fields are:
Author(s): The iAM.AMR Team.
Date: 2022
Title: The iAM.AMR Project Documentation.
URL: https://docs.iam.amr.pub
DOI: (see below).
We use Zenodo to generate DOIs for our documentation.
Zenodo provides a static DOI for the project (a concept DOI), and a version DOI for each GitHub release (more details).
You can use the Concept DOI representing all versions in citations when it is desirable to cite an evolving research artifact, without being specific about the version.
You should normally always use the DOI for the specific version of your record in citations. This is to ensure that other researchers can access the exact research artefact you used for reproducibility. By default, Zenodo uses the specific version to generate citations.
python -m pipenv --venv
python -m pipenv shell
.\make.bat html
If recent changes have been made to the documentation, they may not be reflected in browser, or may be incorrectly displayed due to cached elements (like the navigation side-bar).
We can clear the cache specifically for the documentation site.
chrome://settings/siteData
into the omnibox (the address bar).docs.iam.amr.pub
, or as the base domain amr.pub
.about:preferences#privacy
into the address bar.amr.pub
.