IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doc: move API docs in their own chapter and add more of it.

Browse Source
This commit is contained in:
Georg Brandl
2014-01-20 17:21:44 +01:00
parent aecf35c1bd
commit 883324fd6c
12 changed files with 364 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/extdev/builderapi.rst Normal file
View File

@@ -0,0 +1,30 @@
.. _writing-builders:
Builder API
===========
.. todo:: Expand this.
.. currentmodule:: sphinx.builders
.. class:: Builder
This is the base class for all builders.
These methods are predefined and will be called from the application:
.. automethod:: get_relative_uri
.. automethod:: build_all
.. automethod:: build_specific
.. automethod:: build_update
.. automethod:: build
These methods can be overridden in concrete builder classes:
.. automethod:: init
.. automethod:: get_outdated_docs
.. automethod:: get_target_uri
.. automethod:: prepare_writing
.. automethod:: write_doc
.. automethod:: finish