Commit634151a

committed

maybe fix readthedocs by adding configuration (#1794)

It seems they now require a configuration file.Also the theme configuration changed.It's nice they were stable for more than 10 years though.

1 parentf288738 commit634151aCopy full SHA for 634151a

File tree

+36

-1

lines changed

+36

-1

lines changed

Lines changed: 35 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,35 @@`
	`1`	`+# Read the Docs configuration file for Sphinx projects`
	`2`	`+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details`
	`3`	`+`
	`4`	`+# Required`
	`5`	`+version:2`
	`6`	`+`
	`7`	`+# Set the OS, Python version and other tools you might need`
	`8`	`+build:`
	`9`	`+os:ubuntu-22.04`
	`10`	`+tools:`
	`11`	`+python:"3.12"`
	`12`	`+# You can also specify other tool versions:`
	`13`	`+# nodejs: "20"`
	`14`	`+# rust: "1.70"`
	`15`	`+# golang: "1.20"`
	`16`	`+`
	`17`	`+# Build documentation in the "docs/" directory with Sphinx`
	`18`	`+sphinx:`
	`19`	`+configuration:doc/source/conf.py`
	`20`	`+# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs`
	`21`	`+# builder: "dirhtml"`
	`22`	`+# Fail on all warnings to avoid broken references`
	`23`	`+# fail_on_warning: true`
	`24`	`+`
	`25`	`+# Optionally build your docs in additional formats such as PDF and ePub`
	`26`	`+# formats:`
	`27`	`+# - pdf`
	`28`	`+# - epub`
	`29`	`+`
	`30`	`+# Optional but recommended, declare the Python requirements required`
	`31`	`+# to build your documentation`
	`32`	`+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html`
	`33`	`+# python:`
	`34`	`+# install:`
	`35`	`+# - requirements: docs/requirements.txt`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@`
`93`	`93`	`# Options for HTML output`
`94`	`94`	`# -----------------------`
`95`	`95`
`96`		`-html_theme="sphinx_rtd_theme"`
	`96`	`+#html_theme = "sphinx_rtd_theme"`
`97`	`97`	`html_theme_options= {}`
`98`	`98`
`99`	`99`	`# The name for this set of Sphinx documents. If None, it defaults to`

Comments

(0)