Skip to content

Collab4exaNBody/doc_exaStamp

Repository files navigation

Documentation

exaStamp documentation is built using Zensical.

Prerequisities

python3 -m venv .venv
source .venv/bin/activate
pip install zensical
# Inf SSL verification causes trouble:
pip install --trusted-host pypi.org --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --proxy http://proxy.dam.intra.cea.fr:3128 zensical

Preview as you write

Zensical includes a web server, so you can preview exaStamp documentation site as you write. The server will automatically rebuild the site when you make changes to source files. Start it with:

zensical serve

Point your browser to localhost:8000 and you should see it appear.

Build exaStamp site

When you're finished editing, you can build a static site from your Markdown files with:

zensical build

The contents of this directory make up your project documentation. There's no need for operating a database or server, as it is completely self-contained.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors