|
1 | | -Sphinx 4.2 is used to generate the HTML for the python-oracledb documentation. |
| 1 | +Sphinx is used to generate the HTML for the python-oracledb documentation. |
2 | 2 |
|
3 | 3 | The generated python-oracledb documentation is at https://python-oracledb.readthedocs.io/ |
4 | 4 |
|
5 | 5 | This directory contains the documentation source. It is written using reST |
6 | | -(re-Structured Text) format source files which are processed using Sphinx and |
7 | | -turned into HTML, PDF or ePub documents. If you wish to build these yourself, |
8 | | -you need to install Sphinx 4.2. Sphinx is available on many Linux distributions as a |
9 | | -pre-built package. You can also install Sphinx 4.2 on all platforms using the Python |
10 | | -package manager "pip". To install Sphinx 4.2, run the following command: |
11 | | -pip install Sphinx==4.2.0 |
| 6 | +(re-Structured Text). The source files are processed using Sphinx and can be |
| 7 | +turned into HTML, PDF or ePub documentation. |
| 8 | + |
| 9 | +If you wish to build documentation yourself, install Sphinx. It is available |
| 10 | +on many Linux distributions as a pre-built package. You can also install it |
| 11 | +using the Python package manager "pip", for example:: |
| 12 | + |
| 13 | + python -m pip install Sphinx |
12 | 14 |
|
13 | 15 | For more information on Sphinx, please visit this page: |
14 | 16 |
|
15 | 17 | http://www.sphinx-doc.org |
16 | 18 |
|
17 | | -Once Sphinx 4.2 is installed, the supplied Makefile can be used to build the |
18 | | -different targets. |
| 19 | +Once Sphinx is installed, the supplied Makefile can be used to build the |
| 20 | +different targets, for example to build the HTML documentation, run:: |
| 21 | + |
| 22 | + make |
| 23 | + |
| 24 | +To make ePub documentation, run:: |
| 25 | + |
| 26 | + make epub |
| 27 | + |
| 28 | +To make PDF documentation, run:: |
| 29 | + |
| 30 | + make pdf |
| 31 | + |
| 32 | +The program ``latexmk`` may be required by Sphinx to generate PDF output. |
0 commit comments