Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RTD Fixes to enable publishing #1829

Merged
merged 1 commit into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: 2

build:
os: "ubuntu-20.04"
tools:
python: "3.6"

sphinx:
builder: dirhtml
configuration: docs/source/conf.py

python:
install:
- requirements: docs/source/requirements.txt
14 changes: 11 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,14 @@
import os
import sys
import sphinx_rtd_theme
import recommonmark
from recommonmark.transform import AutoStructify

sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------

project = u'Hyperledger Indy Node'
copyright = u'2018, Hyperledger'
copyright = u'2024, Hyperledger'
author = u'Hyperledger'

# The short X.Y version
Expand All @@ -43,8 +45,14 @@
# ones.
extensions = [
'sphinx.ext.intersphinx',
'recommonmark',
'sphinx.ext.autosectionlabel',
]

# Prefix document path to section labels, otherwise autogenerated labels would look like 'heading'
# rather than 'path/to/file:heading'
autosectionlabel_prefix_document = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand All @@ -63,7 +71,7 @@
#
# 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"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down Expand Up @@ -229,7 +237,7 @@ def setup(app):

except:
e = sys.exc_info()[0]
print e
print(e)
finally:
os.system("rm -rf remote_conf/ __pycache__/ remote_conf.py")

Expand Down
8 changes: 5 additions & 3 deletions docs/source/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
recommonmark==0.4.0
Sphinx==1.8.2
sphinx-rtd-theme==0.4.2
# Defining the exact versions for ReadTheDocs that will make sure things don't break
sphinx==5.3.0
sphinx_rtd_theme==1.1.1
readthedocs-sphinx-search==0.3.2
recommonmark
Loading