Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API reference generated by Sphinx #212

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Commits on Sep 22, 2024

  1. Add API reference generated by Sphinx

    This is `sphinx-quickstart` as modified to automatically produce
    documentation for the module, taking a few hints from fonttools/ufoLib2
    to inform structure, build workflow, and styling.
    Hoolean committed Sep 22, 2024
    Configuration menu
    Copy the full SHA
    6c991df View commit details
    Browse the repository at this point in the history
  2. Restrict star-exports to objects defined in this module

    Having an explicit __all__ is necessary to avoid re-exporting objects
    that we ourselves have imported (e.g. from the standard library).
    
    This also helps avoid objects that this project did not author from
    appearing in the automatically generated Sphinx documentation.
    
    This list was generated by:
    
    ```python
    import uharfbuzz
    print(dir(uharfbuzz))
    ```
    
    ...before being manually pruned.
    Hoolean committed Sep 22, 2024
    Configuration menu
    Copy the full SHA
    73edc81 View commit details
    Browse the repository at this point in the history

Commits on Sep 24, 2024

  1. Configuration menu
    Copy the full SHA
    c92572a View commit details
    Browse the repository at this point in the history
  2. Pin Sphinx requirements for reproducible builds

    This is following the guidance at:
    
        https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
    
    ...in preparation for adding Read the Docs build support, where having
    an explicit requirements.txt file to point to will also be helpful.
    Hoolean committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    4d02b4b View commit details
    Browse the repository at this point in the history
  3. Add Read the Docs configuration file

    This is based on the Sphinx reference config file here:
    
        https://docs.readthedocs.io/en/stable/config-file/v2.html#python-install
    
    ...with some trimming, customisation for the project, and additional
    adjustments recommended for reproducible builds.
    Hoolean committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    38ef9e8 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    dcf7c27 View commit details
    Browse the repository at this point in the history