diff --git a/.readthedocs.yaml b/.readthedocs.yaml index dbdb0b5..c6044ed 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,6 +4,9 @@ build: os: ubuntu-24.04 tools: python: "3.10" + commands: + - rm -f docs/multibase.rst docs/modules.rst + - sphinx-apidoc -o docs/ multibase sphinx: configuration: docs/conf.py diff --git a/README.rst b/README.rst index 8523673..01fc989 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,3 @@ -**This project is no longer maintained and has been archived.** - py-multibase ------------ diff --git a/docs/conf.py b/docs/conf.py index 90dfc01..af780c6 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -50,13 +50,13 @@ templates_path = ['_templates'] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = {'.rst': 'restructuredtext'} # The encoding of source files. #source_encoding = 'utf-8-sig' -# The master toctree document. -master_doc = 'index' +# The root toctree document. +root_doc = 'index' # General information about the project. project = u'py-multibase' diff --git a/newsfragments/31.docs.rst b/newsfragments/31.docs.rst new file mode 100644 index 0000000..c1e8cf2 --- /dev/null +++ b/newsfragments/31.docs.rst @@ -0,0 +1 @@ +Fixed Read the Docs build failures by updating deprecated Sphinx settings and adding API documentation generation.