|
1 | | -Sphinx is used to generate the HTML for the python-oracledb documentation. |
| 1 | +# python-oracledb Documentation Source |
2 | 2 |
|
3 | | -The generated python-oracledb documentation is at |
4 | | -https://python-oracledb.readthedocs.io/ |
| 3 | +This directory contains the python-oracledb documentation source. It is written |
| 4 | +using reST (re-Structured Text). The source files are processed using |
| 5 | +[Sphinx](http://www.sphinx-doc.org) and can be turned into HTML, PDF or ePub |
| 6 | +documentation. |
5 | 7 |
|
6 | | -This directory contains the documentation source. It is written using reST |
7 | | -(re-Structured Text). The source files are processed using Sphinx and can be |
8 | | -turned into HTML, PDF or ePub documentation. |
| 8 | +**Visit https://python-oracledb.readthedocs.io/ for pre-built production and |
| 9 | +development python-oracledb documentation** |
9 | 10 |
|
10 | | -If you wish to build documentation yourself, install Sphinx and the Read the |
11 | | -Docs theme. Sphinx is available on many Linux distributions as a pre-built |
12 | | -package. You can also install Sphinx and the Read the Docs theme using the |
13 | | -Python package manager "pip", for example:: |
| 11 | +## Building Documentation Locally |
14 | 12 |
|
15 | | - python -m pip install -r requirements.txt |
| 13 | +To build the documentation locally: |
16 | 14 |
|
17 | | -For more information on Sphinx, please visit this page: |
| 15 | +1. Install Sphinx and the Read the Docs theme using the Python package manager |
| 16 | + ``pip``, for example: |
18 | 17 |
|
19 | | -http://www.sphinx-doc.org |
| 18 | + python -m pip install -r requirements.txt |
20 | 19 |
|
21 | | -Once Sphinx is installed, the supplied Makefile can be used to build the |
22 | | -different targets, for example to build the HTML documentation, run:: |
| 20 | + You can alternatively install these from pre-built packages for your |
| 21 | + operating system. |
23 | 22 |
|
24 | | - make |
| 23 | +2. The "oracledb" module must be built and importable. This is needed for the |
| 24 | + "autodoc" extension to create function signature documentation. |
25 | 25 |
|
26 | | -To make ePub documentation, run:: |
| 26 | +3. Once Sphinx is installed, and "oracledb" can be imported by Python, use the |
| 27 | + Makefile to build your desired documentation format. |
27 | 28 |
|
28 | | - make epub |
| 29 | + To build the HTML documentation: |
29 | 30 |
|
30 | | -To make PDF documentation, run:: |
| 31 | + make |
31 | 32 |
|
32 | | - make pdf |
| 33 | + To make ePub documentation: |
33 | 34 |
|
34 | | -The program ``latexmk`` may be required by Sphinx to generate PDF output. |
| 35 | + make epub |
| 36 | + |
| 37 | + To make PDF documentation: |
| 38 | + |
| 39 | + make pdf |
| 40 | + |
| 41 | + The program ``latexmk`` may be required by Sphinx to generate PDF output. |
0 commit comments