mirror of
https://github.com/craigerl/aprsd.git
synced 2026-10-11 17:51:00 -04:00
docs: fix Read the Docs build configuration
- .readthedocs.yaml pointed at docs/conf.py (does not exist); the Sphinx config is docs/source/conf.py - .readthedocs.yaml installed dev-requirements.txt (does not exist); install the project with its docs extras instead (Sphinx, myst-parser, sphinx-rtd-theme, sphinx-copybutton, alabaster) - install.rst: Python 3.6 or later -> 3.11 (pyproject requires-python >=3.11) - Regenerate docs/source/apidoc (was missing the new aprsd.cmds.export_config and aprsd.cmds.export_plugins modules)
This commit is contained in:
+7
-4
@@ -12,12 +12,15 @@ build:
|
||||
tools:
|
||||
python: "3.11"
|
||||
|
||||
# Build documentation in the docs/ directory with Sphinx
|
||||
# Build documentation in the docs/source directory with Sphinx
|
||||
sphinx:
|
||||
configuration: docs/conf.py
|
||||
configuration: docs/source/conf.py
|
||||
|
||||
# We recommend specifying your dependencies to enable reproducible builds:
|
||||
# Install the project with its docs extras (Sphinx, myst-parser, theme):
|
||||
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
|
||||
python:
|
||||
install:
|
||||
- requirements: dev-requirements.txt
|
||||
- method: pip
|
||||
path: .
|
||||
extra_requirements:
|
||||
- docs
|
||||
|
||||
@@ -20,6 +20,22 @@ aprsd.cmds.dev module
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
aprsd.cmds.export\_config module
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: aprsd.cmds.export_config
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
aprsd.cmds.export\_plugins module
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: aprsd.cmds.export_plugins
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
aprsd.cmds.fetch\_stats module
|
||||
------------------------------
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ APRSD installation
|
||||
Install info in a nutshell
|
||||
--------------------------
|
||||
|
||||
**Pythons**: Python 3.6 or later
|
||||
**Pythons**: Python 3.11 or later
|
||||
|
||||
**Operating systems**: Linux, OSX, Unix
|
||||
|
||||
|
||||
Reference in New Issue
Block a user