shadowfacts/fonttools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Doc/README.md] update documentation build instructions

Browse Source
This commit is contained in:
Chris Simpkins 2020-04-20 13:59:58 -04:00
parent ee983ced06
commit 60cf67c2f5
No known key found for this signature in database
GPG Key ID: 0D0218A71C9DEB09
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Doc/README.md
View File

@ -2,7 +2,7 @@
The fontTools project documentation updates continuously on Read the Docs as the project source changes. The fontTools project documentation updates continuously on Read the Docs as the project source changes.
The documentation is available at **TODO - RTD URL when pushed and available**. The documentation is hosted at https://fonttools.readthedocs.io/.
## Contents ## Contents
@ -16,21 +16,22 @@ The documentation is available at **TODO - RTD URL when pushed and available**.
You must have a Python 3 interpreter and the `pip` Python package manager installed on your system to build the fontTools documentation. You must have a Python 3 interpreter and the `pip` Python package manager installed on your system to build the fontTools documentation.
Pull the fontTools project source files, create a Python virtual environment, and then install fontTools and the documentation build dependencies by executing the following command in the root of the fontTools source repository: Pull the fontTools project source files, create a Python virtual environment, and then install fontTools and the documentation build dependencies by executing the following commands in the root of the fontTools source repository:
``` ```
$ pip install -e . [doc] $ pip install -e . [all]
$ pip install -r Doc/docs-requirements.txt
``` ```
### Build Documentation ### Build Documentation
**With `make`**: execute the following command in the `Doc` directory: **With `make`**: execute the following command in the root of the repository:
``` ```
$ make html $ make docs
``` ```
**Without `make`**: execute the following command in the `Doc` directory: **Without `make`**: execute the following command in the **`Doc` directory**:
``` ```
$ sphinx-build -b html source build $ sphinx-build -b html source build