Fix for readthedocs publishing
Also updated docs generation code caused by deprecated properties in recent version of Sphinx. Change-Id: If3892cde658bb9d92b4b465f8ec4b1b210fc0ec0
This commit is contained in:
parent
6810a529c9
commit
9aef9c6917
28
.readthedocs.yaml
Normal file
28
.readthedocs.yaml
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
# .readthedocs.yml
|
||||||
|
# Read the Docs configuration file
|
||||||
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
||||||
|
|
||||||
|
# Required
|
||||||
|
version: 2
|
||||||
|
|
||||||
|
# Build documentation in the doc/ directory with Sphinx
|
||||||
|
sphinx:
|
||||||
|
configuration: doc/source/conf.py
|
||||||
|
|
||||||
|
# Build documentation with MkDocs
|
||||||
|
#mkdocs:
|
||||||
|
# configuration: mkdocs.yml
|
||||||
|
|
||||||
|
# Optionally build your docs in additional formats such as PDF and ePub
|
||||||
|
formats:
|
||||||
|
- pdf
|
||||||
|
|
||||||
|
build:
|
||||||
|
os: "ubuntu-22.04"
|
||||||
|
tools:
|
||||||
|
python: "3.10"
|
||||||
|
|
||||||
|
# Optionally set the version of Python and requirements required to build your docs
|
||||||
|
python:
|
||||||
|
install:
|
||||||
|
- requirements: doc/requirements.txt
|
@ -1,2 +1,2 @@
|
|||||||
sphinx>=1.6.2
|
sphinx
|
||||||
sphinx_rtd_theme>=0.4.3
|
sphinx_rtd_theme
|
||||||
|
@ -19,7 +19,7 @@
|
|||||||
# import os
|
# import os
|
||||||
# import sys
|
# import sys
|
||||||
# sys.path.insert(0, os.path.abspath('.'))
|
# sys.path.insert(0, os.path.abspath('.'))
|
||||||
import sphinx_rtd_theme
|
# import sphinx_rtd_theme
|
||||||
|
|
||||||
|
|
||||||
# -- General configuration ------------------------------------------------
|
# -- General configuration ------------------------------------------------
|
||||||
@ -89,9 +89,8 @@ todo_include_todos = False
|
|||||||
#
|
#
|
||||||
html_logo = '_static/airship.logo.white.svg'
|
html_logo = '_static/airship.logo.white.svg'
|
||||||
html_theme = "sphinx_rtd_theme"
|
html_theme = "sphinx_rtd_theme"
|
||||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
||||||
html_theme_options = {
|
html_theme_options = {
|
||||||
'display_version': False,
|
|
||||||
'logo_only': True
|
'logo_only': True
|
||||||
}
|
}
|
||||||
html_show_sourcelink = False
|
html_show_sourcelink = False
|
||||||
|
Loading…
x
Reference in New Issue
Block a user