Skip to content

Commit

Permalink
Fix ReadTheDocs builds (#3950)
Browse files Browse the repository at this point in the history
  • Loading branch information
janette authored Apr 28, 2023
1 parent 08afa40 commit d4cc802
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 8 deletions.
29 changes: 29 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.9"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/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:
- requirements: docs/requirements.txt
6 changes: 3 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
pygments==2.14.0
myst-parser>=1.0.0
sphinx==6.1.3
sphinx-rtd-theme>=1.2.0
myst-parser==1.0.0
sphinxcontrib-httpdomain==1.8.1
sphinxcontrib-httpdomain>=1.8.1
pygments>=2.14
11 changes: 8 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
#
import os
import sys
sys.path.insert(0, os.path.abspath('../../modules/'))
#sys.path.insert(0, os.path.abspath('../../modules/'))
#sys.path.append(os.path.abspath('..'))


# -- Project information -----------------------------------------------------
Expand All @@ -22,7 +23,7 @@
author = 'CivicActions'

# The full version, including alpha/beta/rc tags
release = '2.14.3'
release = '2.15.2'
version = '2.x'

# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -68,7 +69,11 @@
lexers["php-annotations"] = PhpLexer(startinline=True, linenos=1)

# The suffix of source filenames.
source_suffix = ['.rst', '.md']
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
}
source_parsers = {'.md': 'myst_parser.sphinx_'}

autosectionlabel_prefix_document = True
autosectionlabel_maxdepth=None
2 changes: 1 addition & 1 deletion docs/source/developer-guide/decoupled_frontend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ Decoupled Frontend
==================

.. include:: ../../../modules/dkan_js_frontend/README.md
:parser: myst_parser.sphinx_
:parser: myst_parser.docutils_
2 changes: 1 addition & 1 deletion docs/source/developer-guide/dev_metastore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ DKAN Metastore
==================

.. include:: ../../../modules/metastore/README.md
:parser: myst_parser.sphinx_
:parser: myst_parser.docutils_

0 comments on commit d4cc802

Please sign in to comment.