[Doc] initial draft documentation README
includes local build documentation, style guide, contributing guide, doc license
This commit is contained in:
parent
607dc172bf
commit
8773b1202b
134
Doc/README.md
Normal file
134
Doc/README.md
Normal file
@ -0,0 +1,134 @@
|
||||
# fontTools Documentation
|
||||
|
||||
The fontTools project documentation updates continuously on Read the Docs as the project source changes.
|
||||
|
||||
The documentation can be found at **TODO - RTD URL when pushed and available**.
|
||||
|
||||
## Contents
|
||||
|
||||
- [How to Build Local Documentation](#how-to-build-local-documentation)
|
||||
- [Contributing to the fontTools Documentation](#contributing-to-the-documentation)
|
||||
- [Documentation License](#documentation-license)
|
||||
|
||||
## How to Build Local Documentation
|
||||
|
||||
### Install Dependencies
|
||||
|
||||
You must have a Python 3 interpreter and the `pip` Python package manager installed on your system to build the fontTools documentation.
|
||||
|
||||
Use the following command to install the necessary Python build dependencies:
|
||||
|
||||
```
|
||||
$ pip3 install sphinx sphinxcontrib-napoleon sphinx-rtd-theme
|
||||
```
|
||||
|
||||
### Clone the fontTools repository
|
||||
|
||||
Use the following command to clone the fontTools repository with `git`:
|
||||
|
||||
```
|
||||
$ git clone https://github.com/fonttools/fonttools.git
|
||||
```
|
||||
|
||||
### Build Documentation
|
||||
|
||||
Navigate to the `Doc` directory of the fontTools repository.
|
||||
|
||||
If `make` is installed on your system, execute the following command in the `Doc` directory:
|
||||
|
||||
```
|
||||
$ make html
|
||||
```
|
||||
|
||||
If `make` is not installed on your system, use the following command in the `Doc` directory:
|
||||
|
||||
```
|
||||
$ sphinx-build -b html source build
|
||||
```
|
||||
|
||||
Open the `Doc/build/html/index.html` file in your browser to view the home page of the documentation.
|
||||
|
||||
## Contributing to the Documentation
|
||||
|
||||
We highly encourage contributions! Please follow the instructions below to improve the documentation.
|
||||
|
||||
### Setup a fontTools Development Environment
|
||||
|
||||
Please use the [installation instructions on the fontTools README](https://github.com/fonttools/fonttools/blob/master/README.rst#installation) to setup a development environment. This will allow you to build and review local builds of documentation files before you submit your changes.
|
||||
|
||||
### Python Docstring Style
|
||||
|
||||
We recommend use of Python docstrings that follow [the Google Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#381-docstrings). Our documentation build approach parses properly formatted docstrings into formatted documentation files.
|
||||
|
||||
#### Function Documentation Example
|
||||
|
||||
```python
|
||||
def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
|
||||
"""Fetches rows from a Bigtable.
|
||||
|
||||
Retrieves rows pertaining to the given keys from the Table instance
|
||||
represented by big_table. Silly things may happen if
|
||||
other_silly_variable is not None.
|
||||
|
||||
Args:
|
||||
big_table: An open Bigtable Table instance.
|
||||
keys: A sequence of strings representing the key of each table row
|
||||
to fetch.
|
||||
other_silly_variable: Another optional variable, that has a much
|
||||
longer name than the other args, and which does nothing.
|
||||
|
||||
Returns:
|
||||
A dict mapping keys to the corresponding table row data
|
||||
fetched. Each row is represented as a tuple of strings. For
|
||||
example:
|
||||
|
||||
{'Serak': ('Rigel VII', 'Preparer'),
|
||||
'Zim': ('Irk', 'Invader'),
|
||||
'Lrrr': ('Omicron Persei 8', 'Emperor')}
|
||||
|
||||
If a key from the keys argument is missing from the dictionary,
|
||||
then that row was not found in the table.
|
||||
|
||||
Raises:
|
||||
IOError: An error occurred accessing the bigtable.Table object.
|
||||
"""
|
||||
```
|
||||
*Source: [Google Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md) (CC BY-SA 3.0)*
|
||||
|
||||
#### Class Documentation Example
|
||||
|
||||
```python
|
||||
class SampleClass(object):
|
||||
"""Summary of class here.
|
||||
|
||||
Longer class information....
|
||||
Longer class information....
|
||||
|
||||
Attributes:
|
||||
likes_spam: A boolean indicating if we like SPAM or not.
|
||||
eggs: An integer count of the eggs we have laid.
|
||||
"""
|
||||
|
||||
def __init__(self, likes_spam=False):
|
||||
"""Inits SampleClass with blah."""
|
||||
self.likes_spam = likes_spam
|
||||
self.eggs = 0
|
||||
|
||||
def public_method(self):
|
||||
"""Performs operation blah."""
|
||||
```
|
||||
*Source: [Google Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md) (CC BY-SA 3.0)*
|
||||
|
||||
### Build Local Documentation and Review Your Changes
|
||||
|
||||
Please use the instructions above to build a local set of HTML documentation files with the Read the Docs theme and review your changes.
|
||||
|
||||
### Submit a Pull Request
|
||||
|
||||
Submit a Github pull request with your proposed improvements to the documentation.
|
||||
|
||||
Thanks for your contribution!
|
||||
|
||||
## Documentation License
|
||||
|
||||
The fontTools documentation is released under a [CC BY-SA 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).
|
Loading…
x
Reference in New Issue
Block a user