Skip to content

Commit

Permalink
Upgrade Jinja2 to v3.1.3 as per hyperledger#4607.
Browse files Browse the repository at this point in the history 
The version of Sphinx we were using is simply not compatible
with Jinja2 > v3.0.3, so given that we had to upset the delicate
balance of requirements anyway, the goal of this PR is now to
bring all docs infrastructure for CI/CD as well as dependencies
and indeed the docs themselves to the latest version.

Signed-off-by: Ben Smith <[email protected]>
  • Loading branch information
@benjsmi
benjsmi committed Jan 17, 2024
1 parent fdb3255 commit 86dc8e1
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 181 deletions.
42 changes: 28 additions & 14 deletions docs/requirements.txt
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,38 @@
# SPDX-License-Identifier: Apache-2.0
alabaster==0.7.13
Babel==2.12.1
certifi==2023.7.22
charset-normalizer==3.2.0
alabaster==0.7.16
Babel==2.14.0
certifi==2023.11.17
charset-normalizer==3.3.2
commonmark==0.9.1
docutils==0.17.1
idna==3.4
docutils==0.20.1
idna==3.6
imagesize==1.4.1
Jinja2==3.0.3
importlib-metadata==6.7.0
Jinja2==3.1.3
markdown-it-py==3.0.0
MarkupSafe==2.1.3
packaging==23.1
Pygments==2.15.1
mdit-py-plugins==0.4.0
mdurl==0.1.2
myst-parser==2.0.0
packaging==23.2
Pygments==2.17.2
python-markdown-math==0.2
pytz==2023.3
PyYAML==6.0.1
readthedocs-sphinx-ext==2.2.5
recommonmark==0.7.1
requests==2.31.0
six==1.16.0
snowballstemmer==2.2.0
Sphinx==1.8.6
sphinx-rtd-theme==1.2.2
Sphinx==7.2.6
sphinx-rtd-theme==2.0.0
sphinxcontrib-applehelp==1.0.8
sphinxcontrib-devhelp==1.0.6
sphinxcontrib-htmlhelp==2.0.5
sphinxcontrib-jquery==4.1
sphinxcontrib-serializinghtml==1.1.5
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.7
sphinxcontrib-serializinghtml==1.1.10
sphinxcontrib-websupport==1.2.4
urllib3==1.26.18
typing_extensions==4.7.1
urllib3==2.1.0
zipp==3.15.0
224 changes: 57 additions & 167 deletions docs/source/conf.py
View file
Original file line number Diff line number Diff line change
@@ -1,226 +1,116 @@
# -*- coding: utf-8 -*-
# Copyright IBM Corp. All Rights Reserved.
#
# SPDX-License-Identifier: Apache-2.0
#
# hyperledger-fabricdocs documentation build configuration file, created by
# sphinx-quickstart on Mon Feb 20 16:11:53 2017.
# Configuration file for the Sphinx documentation builder.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# 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
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
import sphinx_rtd_theme
from os import environ

sys.path.insert(0, os.path.abspath('.'))

rtd_tag = 'release-2.2'
import sphinx_rtd_theme

rtd_tag = 'latest'
if environ.get('READTHEDOCS_VERSION') is not None:
rtd_tag = os.environ['READTHEDOCS_VERSION']


placeholder_replacements = {
"{BRANCH}" : "release-2.2",
"{BRANCH}": "main",
"{BRANCH_DOC}" : "latest", # Used to target the correct ReadTheDocs distribution version
"{RTD_TAG}": rtd_tag
}

# -- General configuration ------------------------------------------------
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
project = u'Hyperledger Fabric Docs'
copyright = u'2017-2024, Hyperledger Foundation'
author = u'Hyperledger Foundation'
release = u'main'
version = u'main'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.imgmath',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode']
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# 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
# documentation root, use os.path.abspath to make it absolute, like shown here.
#

# recommonmark is a python utility that allows markdown to be used within
# Sphinx projects.
# Installed version as per directive in docs/requirement.txt
from recommonmark.parser import CommonMarkParser

source_parsers = {
'.md': CommonMarkParser,
'.md': 'recommonmark.parser.CommonMarkParser',
}

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ['.rst', '.md']

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'hyperledger-fabricdocs'
copyright = u'2017, hyperledger'
author = u'hyperledger'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'main'
# The full version, including alpha/beta/rc tags.
release = u'main'
# The file extensions of source files. Sphinx considers the files with this suffix as sources.
# The value can be a dictionary mapping file extensions to file types. For example:
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown'
}

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# 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
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# Used to be "master_doc"
# The main toctree document
root_doc = 'index'

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

extensions = ['sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.imgmath',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'myst_parser']

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# -- Special API Accesses -------------------------------------------------
# They create an instance of the Sphinx object, documented here
# https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx
# and pass it to us as "app" in this setup function.
#
# html_theme_options = {}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# We then call it to perform special/specific customizations.

def placeholderReplace(app, docname, source):
result = source[0]
for key in app.config.placeholder_replacements:
result = result.replace(key, app.config.placeholder_replacements[key])
source[0] = result


def setup(app):
app.add_stylesheet('css/custom.css')
app.add_css_file('css/custom.css')
app.add_config_value('placeholder_replacements', {}, True)
app.connect('source-read', placeholderReplace)

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'hyperledger-fabricdocsdoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'hyperledger-fabricdocs.tex', u'hyperledger-fabricdocs Documentation',
u'hyperledger', 'manual'),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'hyperledger-fabricdocs', u'hyperledger-fabricdocs Documentation',
[author], 1)
]


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'hyperledger-fabricdocs', u'hyperledger-fabricdocs Documentation',
author, 'hyperledger-fabricdocs', 'One line description of project.',
'Miscellaneous'),
]



# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''
html_theme = 'sphinx_rtd_theme'

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# html_css_files = ['css/custom.css']

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# Skip the links with anchor tags during the linkcheck
linkcheck_anchors = False
html_static_path = ['_static']

# Increase the linkcheck timeout to 5 seconds
linkcheck_timeout = 5
html_add_permalinks = True

0 comments on commit 86dc8e1

Please sign in to comment.