upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-05-28 04:34:11 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
certbot/acme/docs/index.rst

33 lines
559 B
ReStructuredText
Raw Permalink Normal View History

sphinx-quickstart for subpkgs ``` sphinx-quickstart --dot _ --project acme-python --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile acme/docs sphinx-quickstart --dot _ --project letsencrypt-apache --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-apache/docs sphinx-quickstart --dot _ --project letsencrypt-nginx --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-nginx/docs sphinx-quickstart --dot _ --project letshelp-letsencrypt --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letshelp-letsencrypt/docs sphinx-quickstart --dot _ --project letsencrypt-compatibility-test --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-compatibility-test/docs ```
2015-10-18 09:42:17 -04:00
.. acme-python documentation master file, created by
sphinx-quickstart on Sun Oct 18 13:38:06 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to acme-python's documentation!
=======================================
Contents:
.. toctree::
:maxdepth: 2
Split docs into subpkgs (fixes #969)
2015-10-18 10:17:10 -04:00
api
sphinx-quickstart for subpkgs ``` sphinx-quickstart --dot _ --project acme-python --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile acme/docs sphinx-quickstart --dot _ --project letsencrypt-apache --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-apache/docs sphinx-quickstart --dot _ --project letsencrypt-nginx --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-nginx/docs sphinx-quickstart --dot _ --project letshelp-letsencrypt --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letshelp-letsencrypt/docs sphinx-quickstart --dot _ --project letsencrypt-compatibility-test --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-compatibility-test/docs ```
2015-10-18 09:42:17 -04:00
Split ACME API docs
2015-10-18 12:01:27 -04:00
.. automodule:: acme
:members:
sphinx-quickstart for subpkgs ``` sphinx-quickstart --dot _ --project acme-python --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile acme/docs sphinx-quickstart --dot _ --project letsencrypt-apache --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-apache/docs sphinx-quickstart --dot _ --project letsencrypt-nginx --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-nginx/docs sphinx-quickstart --dot _ --project letshelp-letsencrypt --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letshelp-letsencrypt/docs sphinx-quickstart --dot _ --project letsencrypt-compatibility-test --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-compatibility-test/docs ```
2015-10-18 09:42:17 -04:00
Include example ACME client in docs
2015-10-28 03:16:40 -04:00
Example client:
.. include:: ../examples/example_client.py
:code: python
sphinx-quickstart for subpkgs ``` sphinx-quickstart --dot _ --project acme-python --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile acme/docs sphinx-quickstart --dot _ --project letsencrypt-apache --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-apache/docs sphinx-quickstart --dot _ --project letsencrypt-nginx --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-nginx/docs sphinx-quickstart --dot _ --project letshelp-letsencrypt --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letshelp-letsencrypt/docs sphinx-quickstart --dot _ --project letsencrypt-compatibility-test --author Let's Encrypt Project -v 0 --release 0 --language en --suffix .rst --master index --ext-autodoc --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode --makefile --batchfile letsencrypt-compatibility-test/docs ```
2015-10-18 09:42:17 -04:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Reference in a new issue Copy permalink