spacetx.github.io

How to build website locally

1. Install Pandoc

If you use Conda,

conda install pandoc

or

sudo apt install pandoc

2. Install required python packages

pip install sphinx recommonmark ipython nbsphinx sphinx-autobuild

3. Build website.

sphinx-autobuild src build

And find the result in build directory.

How to add a new page

1. Add a new document in src/. The file format can be either rst or md.
2. Open src/_template/layout.html. Go to line 35. Append a new link there (put document file name without extension).
3. Add a link to src/toctree.rst.

How to add a new topic or example

1. Add a new document in src/topics or src/examples. The file format can be either rst or md.
2. Done! The document will be automatically published soon.