docs's Introduction

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

docs's People

Contributors

Stargazers

Watchers

docs's Issues

emonpi firmware upgrade docs

On https://docs.openenergymonitor.org/emonpi/firmware.html it documents that the "LowPowerLabs" firmware is newer, and recommended.

After upgrading, what does a user need to do? Nothing? Restart? Full power cycle? Change some config or reconfigure anything?

Broken "Test Rig" SVG image embed in YHDC SCT-013-000 Current Transformer report page

Viewing YHDC SCT-013-000 Current Transformer report I see the following under the Test Rig section:

The embedded frame URL is https://docs.openenergymonitor.org/electricity-monitoring/ct-sensors/files/C.T.%20Test%20Rig.160705.svg which results in a 404 response from apache:

$ curl https://docs.openenergymonitor.org/electricity-monitoring/ct-sensors/files/C.T.%20Test%20Rig.160705.svg
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<html><head>
<title>404 Not Found</title>
</head><body>
<h1>Not Found</h1>
<p>The requested URL was not found on this server.</p>
<hr>
<address>Apache/2.4.41 (Ubuntu) Server at docs.openenergymonitor.org Port 443</address>
</body></html>