Skip to content

itailv/sphinx-rtd-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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

About

πŸ“’ Using Sphinx, ReadTheDocs, Autodoc & Jupyter-Execute to document your project

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages