LIneA Documentation

This repository is a fork of NERSC Documentation at docs.nersc.gov.

This repository contains LIneA documentation written in Markdown which is converted to html/css/js with the mkdocs static site generator. The theme is mkdocs-material with LIneA customizations such as the colors injected via selective overloading of templates and CSS. The documentation pages are found in the top-level folder docs.

Reporting Issues

To report a problem with our documentation please create an issue and someone will work on your task. Before you create a ticket, please check if there is an existing issue for the same problem to avoid duplicate issues.

If you need any further assistance send an email to [email protected].

How to build the documentation

1. Create the python virtual env

apt-get install python-pip python3.10-venv
python3 -m venv envdocs
source envdocs/bin/activate

2. Clone the repo and install all packages

git clone https://github.com/linea-it/docs/
cd docs
pip install -r requirements.txt

To run a local server using mkdocs:

cd docs
source ../envdocs/bin/activate        # if not loaded
mkdocs serve -a 127.0.0.1:8088     # the argument '-a 127.0.0.1:8088' is optional

To deploy on github pages:

cd docs
source ../envdocs/bin/activate        # if not loaded
mkdocs gh-deploy -c --config-file mkdocs.yml --remote-branch gh-pages

License

This repository is licensed under the BSD 3-Clause. For more details, see LICENSE.