GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — circuitpython/docs at main · adafruit/circuitpython

Expand file tree

/

docs

/
Copy path

Directory actions

More options

More options

Directory actions

More options

More options

Latest commit

 

History

History
History
 
 
/

docs

/
Copy path

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
autoapi/templates/python
autoapi/templates/python
 
 
library
library
 
 
readthedocs/settings
readthedocs/settings
 
 
reference
reference
 
 
static
static
 
 
templates
templates
 
 
LICENSE.md
LICENSE.md
 
 
README.md
README.md
 
 
common_hal.md
common_hal.md
 
 
design_guide.rst
design_guide.rst
 
 
environment.rst
environment.rst
 
 
index.rst
index.rst
 
 
libraries.rst
libraries.rst
 
 
llms_txt.py
llms_txt.py
 
 
pdf.rst
pdf.rst
 
 
porting.rst
porting.rst
 
 
redirects.txt
redirects.txt
 
 
rstjinja.py
rstjinja.py
 
 
shared_bindings_matrix.py
shared_bindings_matrix.py
 
 
supported_ports.rst
supported_ports.rst
 
 
troubleshooting.rst
troubleshooting.rst
 
 
workflows.md
workflows.md
 
 

README.md

Outline

Adafruit CircuitPython Documentation

The latest documentation can be found at: http://circuitpython.readthedocs.io/en/latest/

The documentation you see there is generated from the files in the whole tree: https://github.com/adafruit/circuitpython/tree/main

Building the documentation locally

If you're making changes to the documentation, you should build the documentation locally so that you can preview your changes.

Install the necessary packages, preferably in a virtualenv, in circuitpython/:

pip install -r requirements-doc.txt

In circuitpython/, build the docs:

make html

You'll find the index page at _build/html/index.html.

More flexibility

Running make by itself will list out the multiple doc generating commands available.

All commands will, by default, run with -E (forces a rebuild from scratch of docs) and -v (verbosity level 1). This can be customized as desired:

# will turn OFF the force rebuild
make html FORCE=

# will turn OFF the verbosity
make html VERBOSE=

# will turn OFF the force rebuild and make it doubly verbose when running
make html FORCE= VERBOSE="-v -v"

You can also pass other options to sphinx by using SPHINXOPTS.

make html SPHINXOPTS="-T"

For more flexibility and customization, take a look at the Makefile for all variables you can pass in and overwrite.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.