itailv / sphinx-rtd-example

📒 Using Sphinx, ReadTheDocs, Autodoc & Jupyter-Execute to document your project

Installation

    # Clone or download this repo
    git clone https://github.com/itailv/sphinx-rtd-example.git
    cd sphinx-rtd-example
    
    # Install requirements
    pip install -r requirements

Generating Documentation

To generate ReadTheDocs for your project, just follow:

    cd docs
    make clean
    make build

And your build should be in your-project-name/docs/_build