Git Product home page Git Product logo

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

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

glynhudson avatar slyremarks avatar trystanlea avatar rosanarufer avatar sarahjhanson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.