Stlib documentation

Repository for building the documentation pages for the Fortran standard library (stdlib).

Getting started

Get the code

git clone https://github.com/awvwgk/stdlib-docs
cd stdlib-docs

Install dependencies

The documentation pages are created using sphinx. You first need to install the required dependencies using conda or pip. This project uses

• sphinx-build for building the pages
• sphinx-intl for translations
• ablog for the news section and posts
• sphinx-book-theme for the page theme
• myst-parser for markdown support
• sphinx-design for the bootstrap building blocks
• sphinx-copybutton to allow copying of code-blocks

conda

conda env create -n sphinx -f environment.yaml
conda activate sphinx

pip

python3 -m venv venv
source venv/bin/activate
pip install -U pip
pip install -r requirements.txt

Build stdlib-docs

Build the documentation by invoking

make html

The website will be built in _build/html and can be previewed by opening the page with a browser (e.g. firefox, chromium or similar):

firefox file://$PWD/_build/html/index.html

By default all languages will be built. To limit the build to a single language subtree, i.e. English, use

make html LANGUAGES=en