stonet-research / stonet-research.github.io

StoNet Website

Build and run locally

This site is built using Sphinx with read-the-docs theme.

Install packages

pip install -r requirements.txt
apt-get install python3-sphinx

build and start a local server

# build the html and start a local http server
make html
cd _build/html
python -m http.server
# or python3
python3 -m http.server

Then the website is available at localhost:8000

Build and make it accessible to github pages

# commit and push
git add *
git commit -m 'commit message'
git push

# If it does not succeed please check https://github.com/stonet-research/stonet-research.github.io/actions or the `Deployments` branch.

How to make changes

The webpages is written in reStructuredText. read the docs rst file example

The main menu is defined in index.rst

The path to the contents can also be found in the rst file.

For example

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Research Projects

   /research_projects/research_projects

is the 'Research Projects' tab and the contents are in /research_projects/research_projects.

The source code of read the docs is a good example:

read the docs tutorial corresponding source code

How to add publications

1. Copy your pdf to publications/pdfs (if available)
2. Add a new entry to publications/publications.rst please add it to corresponding year and use the format "paper name, authors (year) conference (conference link), location. PDF OR DOI.

To reference the pdf from within publications.rst use:

:download:`pdf_name <pdfs/pdf_name>`

How to add people

1. Create a .png image of 512x512 and copy it to people/photos.
2. Add the person to people/people.rst, use the format "role name".

Sources

sphinx doc

read the docs theme doc