Skip to content

Commit

Permalink
Upgrade docs to address security issues in dependencies for Sphinx.
Browse files Browse the repository at this point in the history
Also add a Make command "build-docs" that quickly/easily builds the
docs using Docker for local testing/consumption.

Also modify a copyright in the conf.py file.

Also adjust to using Python v3.7.

Signed-off-by: Ben Smith <benjsmi@us.ibm.com>
  • Loading branch information
benjsmi authored and denyeart committed Jul 28, 2023
1 parent 47a32f2 commit b3bc59e
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 14 deletions.
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,11 @@ vet: .FORCE
docs: gotools fabric-ca-client fabric-ca-server
@scripts/regenDocs

.PHONY: build-docs
build-docs:
@docker run --rm -v $$(pwd):/docs n42org/tox:3.4.0 sh -c 'cd /docs && tox -e docs'


fabric-ca-client: bin/fabric-ca-client
fabric-ca-server: bin/fabric-ca-server

Expand Down
43 changes: 31 additions & 12 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,35 @@
#
python-markdown-math==0.2

alabaster==0.7.8
Babel==2.3.4
docutils==0.12
imagesize==0.7.1
Jinja2==2.11.3
MarkupSafe==0.23
Pygments==2.1.3
pytz==2016.4
six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.4.4
alabaster==0.7.13
Babel==2.12.1
certifi==2023.7.22
charset-normalizer==3.2.0
commonmark==0.9.1
docutils==0.17.1
idna==3.4
imagesize==1.4.1
importlib-metadata==6.7.0
Jinja2==3.0.3
MarkupSafe==2.1.3
packaging==23.1
Pygments==2.15.1
python-markdown-math==0.2
pytz==2023.3
recommonmark==0.7.1
requests==2.31.0
six==1.16.0
snowballstemmer==2.2.0
Sphinx==1.8.6
sphinx-rtd-theme==0.1.9
recommonmark==0.4.0
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jquery==4.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
sphinxcontrib-websupport==1.2.4
typing-extensions==4.7.1
urllib3==1.26.16
zipp==3.15.0
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@

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

# The version info for the project you're documenting, acts as replacement for
Expand Down
4 changes: 3 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
minversion = 1.6
minversion = 3.4
envlist = docs
skipsdist=true

Expand All @@ -9,3 +9,5 @@ commands =
sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/source {toxinidir}/docs/_build/html
echo "Generated docs available in {toxinidir}/docs/_build/html"
whitelist_externals = echo
basepython=python3.7
ignore_basepython_conflict=True

0 comments on commit b3bc59e

Please sign in to comment.