Skip to main content

template project/walkthrough

Project description

femtosphinx

A repository providing some documentation for how to use sphinx.

Also provides the execute_code sphinx extension, which can be enabled with: (in docs/conf.py)

extensions = [
  ...
  'femtosphinx.execute_code',
  ...
]

And then used with the .. exec:: and .. exec_as_bullets:: directives.

Getting started

Install sphinx

pip install sphinx

Read this getting started guide.

Take a look at our intro guide.

Start generating documentation!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

femtosphinx-0.1.4.dev0.tar.gz (5.9 kB view hashes)

Uploaded Source

Built Distribution

femtosphinx-0.1.4.dev0-py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page