Skip to content

openenergymonitor/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

43933a5 · Apr 7, 2025
Apr 7, 2025
Apr 7, 2025
Apr 7, 2025
Apr 7, 2025
Apr 7, 2025
Apr 7, 2025
Apr 7, 2025
Apr 7, 2025
Apr 7, 2025
Apr 7, 2025
Apr 7, 2025
Apr 20, 2024
Nov 27, 2023
May 15, 2024
Nov 27, 2023
Nov 27, 2023
Mar 13, 2024
May 16, 2024
Nov 27, 2023
Nov 27, 2023
Nov 27, 2023

Repository files navigation

OpenEnergyMonitor Documentation

Local Preview

The docs can be built and previewed locally:

1. Clone repo and sub-modules

git clone https://github.com/openenergymonitor/docs
git submodule update --init

2. Install Sphinx

See: http://www.sphinx-doc.org/en/master/usage/installation.html

pip3 install -U sphinx

3. Install The Theme

pip3 install sphinx_rtd_theme

4. Install Plugins

pip3 install m2r myst-parser sphinx_copybutton

5. Build the docs

cd main
make clean
make html

This will generate html output in a build folder. The html can then be displayed using a local web server.

sudo ln -s /home/USERNAME/docs/main/_build/html /var/www/html/docs

Update

git submodule update --recursive --remote