Build with jsdoc
and sphinx-autoapi
¶
This version is built with jsdoc
and sphinx-autoapi
.
A link to the autogenerated API should be shown in the left sidebar.
1version: 2
2
3build:
4 os: ubuntu-22.04
5 tools:
6 python: "3.9"
7 nodejs: "16"
8 jobs:
9 post_install:
10 - npm install -g jsdoc
11
12sphinx:
13 configuration: docs/conf.py
14
15python:
16 install:
17 - requirements: requirements.txt
Sphinx configuration file used to build this docs (see full file),
1project = 'Test Builds'
2extensions = [
3 'sphinx_autorun',
4 'autoapi.extension',
5]
6
7autoapi_dirs = ['../src/']
8autoapi_type = 'javascript'
9
10# Include all your settings here
11html_theme = 'sphinx_rtd_theme'
12
13
14
15
>>> # Build at
>>> import datetime
>>> datetime.datetime.utcnow() # UTC
datetime.datetime(2022, 5, 18, 14, 25, 12, 184588)