Skip to content

Lay3r8/sphinx-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sphinx Example

This is a very simple example of how to autogenerate Google style docs from code using Sphinx with autodoc and napoleon extensions on a Linux machine.

Installation

git clone [email protected]:Lay3r8/sphinx-example.git
cd sphinx-example

# Python setup
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

# Node JS setup (optional if you don't want something to serve the docs)
npm install

Usage

# Generate the docs
cd docs
chmod +x generate_docs.sh
./generate_docs.sh

# Serve the docs
npm run start

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published