Sphinx

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects.

YAML Configuration

sphinx:

  • config-file:

    • Path to conf.py.
    • If this field is omitted:
      • Docstand searches for conf.py under the repository and uses it to build documentation.
      • In case when conf.py has not been found, Docstand generates default conf.py.
  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.5 CPU with 1920 MiB RAM.

      Docstand rounds up the cpu value and specifies it to -j option of sphinx. For example, -j 1 is specified by default (for 0.5 CPU), -j 2 is specified for 1.1 CPU.

Resolving Dependencies

Docstand recursively searches your repository for requirements.txt and runs pip install --user -r at each directory containing the file.

Examples

  • With sphinx set to default

    docstand:
      sphinx: default
    
  • With custom machine:

    docstand:
      sphinx:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With config-file option

    docstand:
      sphinx:
        config-file: src/conf.py
    

results matching ""

    No results matching ""