Merge pull request #105 from planetmint/fix-docs-build

Fix docs build

.readthedocs.yml

@@ -3,36 +3,17 @@
 # SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
 # Code is Apache-2.0 and docs are CC-BY-4.0
 
-#build:
-#    image: latest
 
-#python:
-#    version: 3.9
-#    pip_install: true
-
-
-# Required
 version: 2
 
-# Set the version of Python and other tools you might need
+
 build:
   os: ubuntu-20.04
   tools:
     python: "3.9"
-    # You can also specify other tool versions:
-    # nodejs: "16"
-    # rust: "1.55"
-    # golang: "1.17"
 
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-   configuration: docs/conf.py
-
-# If using Sphinx, optionally build your docs in additional formats such as PDF
-# formats:
-#    - pdf
-
-# Optionally declare the Python requirements required to build your docs
 python:
    install:
+   - method: setuptools
+     path: .
    - requirements: docs/root/requirements.txt

docs/root/requirements.txt

@@ -1,10 +1,40 @@
-Sphinx~=1.0
-recommonmark>=0.4.0
-sphinx-rtd-theme>=0.1.9
-sphinxcontrib-napoleon>=0.4.4
-sphinxcontrib-httpdomain>=1.5.0
-pyyaml>=4.2b1
-aafigure>=0.6
-packaging~=18.0
-wget
-jinja2==3.0.0
+aafigure==0.6
+alabaster==0.7.12
+Babel==2.10.1
+certifi==2021.10.8
+charset-normalizer==2.0.12
+commonmark==0.9.1
+docutils==0.17.1
+idna==3.3
+imagesize==1.3.0
+importlib-metadata==4.11.3
+Jinja2==3.0.0
+markdown-it-py==2.1.0
+MarkupSafe==2.1.1
+mdit-py-plugins==0.3.0
+mdurl==0.1.1
+myst-parser==0.17.2
+packaging==21.3
+pockets==0.9.1
+Pygments==2.12.0
+pyparsing==3.0.8
+pytz==2022.1
+PyYAML==6.0
+recommonmark==0.7.1
+requests==2.27.1
+six==1.16.0
+snowballstemmer==2.2.0
+Sphinx==4.5.0
+sphinx-rtd-theme==1.0.0
+sphinxcontrib-applehelp==1.0.2
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-httpdomain==1.8.0
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-napoleon==0.7
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
+typing-extensions==4.2.0
+urllib3==1.26.9
+wget==3.2
+zipp==3.8.0

docs/root/source/conf.py

@@ -23,9 +23,6 @@ import sys
 import inspect
 
 from os import rename, remove
-from recommonmark.parser import CommonMarkParser
-
-  
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -51,9 +48,12 @@ sys.path.insert(0,parentdir)
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
+project = 'Planetmint'
+
 import sphinx_rtd_theme
 
 extensions = [
+    'myst_parser',
     'sphinx.ext.autosectionlabel',
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
@@ -99,10 +99,6 @@ autodoc_default_options = {
     'members': None,
 }
 
-source_parsers = {
-    '.md': CommonMarkParser,
-}
-
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
@@ -115,9 +111,8 @@ source_suffix = ['.rst', '.md']
 
 # The master toctree document.
 master_doc = 'index'
-
+autosectionlabel_prefix_document = True
 # General information about the project.
-project = 'Planetmint'
 now = datetime.datetime.now()
 copyright = str(now.year) + ', Planetmint Contributors'
 author = 'Planetmint Contributors'
@@ -137,7 +132,7 @@ release = _version['__version__']
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used: