Skip to content

Commit 3728148

Browse files
authored
Fix Read the Docs build failures (#29)
* Fix Read the Docs build failures - Update deprecated Sphinx settings in docs/conf.py: - Replace source_suffix = '.rst' with dict format - Replace master_doc with root_doc - Add build commands to .readthedocs.yaml to generate API docs - Generate modules.rst and multibase.rst before build - Fixes missing 'modules' document warning that caused build to fail * Add newsfragment for issue #31: Fix Read the Docs build failures * doc: removed archived note
1 parent 7c2647e commit 3728148

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

.readthedocs.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ build:
44
os: ubuntu-24.04
55
tools:
66
python: "3.10"
7+
commands:
8+
- rm -f docs/multibase.rst docs/modules.rst
9+
- sphinx-apidoc -o docs/ multibase
710

811
sphinx:
912
configuration: docs/conf.py

README.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
**This project is no longer maintained and has been archived.**
2-
31
py-multibase
42
------------
53

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@
5050
templates_path = ['_templates']
5151

5252
# The suffix of source filenames.
53-
source_suffix = '.rst'
53+
source_suffix = {'.rst': 'restructuredtext'}
5454

5555
# The encoding of source files.
5656
#source_encoding = 'utf-8-sig'
5757

58-
# The master toctree document.
59-
master_doc = 'index'
58+
# The root toctree document.
59+
root_doc = 'index'
6060

6161
# General information about the project.
6262
project = u'py-multibase'

newsfragments/31.docs.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fixed Read the Docs build failures by updating deprecated Sphinx settings and adding API documentation generation.

0 commit comments

Comments
 (0)