Skip to content

Commit

Permalink
Fix readthedocs build (#2394)
Browse files Browse the repository at this point in the history
* Build is broken, update everything

Immediate problem appears to be `funcparserlib`.
See vlasovskikh/funcparserlib#70.

Found mr2r (mr2 is out of date) and can now use sphinx 4.

* Update theme - bullets missing
mikee47 authored Oct 18, 2021
1 parent e66e4f3 commit a817021
Showing 3 changed files with 17 additions and 13 deletions.
6 changes: 4 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -8,11 +8,13 @@ version: 2
# Optionally build your docs in additional formats such as PDF and ePub
formats:
- htmlzip
# - pdf

sphinx:
configuration: docs/source/conf.py

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
version: 3.8
install:
- requirements: docs/requirements.txt

15 changes: 8 additions & 7 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Requirements file for pip
# list of Python packages used in documentation build
sphinx==2.4.4
sphinx-rtd-theme
m2r
breathe==4.13.0
sphinx==4.2.0
sphinx-rtd-theme==1.0.0
m2r2
breathe==4.31.0
sphinxcontrib-wavedrom
sphinx-copybutton
sphinxcontrib-seqdiag>=0.8.5
jinja2>=2.11.3
setuptools==57.5.0
sphinxcontrib-seqdiag==2.0.0
jinja2==2.11.3
setuptools>=57.5.0
funcparserlib==1.0.0a0
9 changes: 5 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -45,7 +45,7 @@
# so developers can more easily locate the appropriate reference documentation.
#
extensions = [
'm2r',
'm2r2',
'breathe',
'sphinxcontrib.seqdiag',
'link-roles',
@@ -101,6 +101,10 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_css_files = [
'custom.css',
]

html_extra_path = [
'../api/html'
]
@@ -134,6 +138,3 @@

subprocess.call('make -C ../../Sming submodules SMING_ARCH=Host', shell=True)
subprocess.call('make -C .. setup api API_VERSION="' + version + '"', shell=True)

def setup(app):
app.add_stylesheet('custom.css')

0 comments on commit a817021

Please sign in to comment.