Cleanup docs building

* Switch to using sphinx-build
* Fix docs warnings
* Remove test-requirement and fold in requirements, we don't need two
  files for this docu only repo.
* Remove unused requirement pytz.
* Update doc requirements
* Remove cruft from setup.cfg and doc/source/conf.py
* Switch to Python3

Change-Id: Iae32f7daa656fca6ae80a750746215fe80d4a0d6
This commit is contained in:
Andreas Jaeger 2020-04-16 17:43:24 +02:00
parent cbcddc560c
commit aad2068896
10 changed files with 20 additions and 31 deletions

View File

@ -72,7 +72,7 @@ class TeamTable(Table):
LOG.info('loading teamtable')
LOG.info('reading %s' % filename)
with open(filename, 'r') as f:
_teams_yaml = yaml.load(f.read())
_teams_yaml = yaml.safe_load(f.read())
table = nodes.table()

View File

@ -134,11 +134,6 @@ html_title = 'OpenStack Governance'
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
html_last_updated_fmt = os.popen(git_cmd).read()
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

View File

@ -9,3 +9,4 @@ Reference documents which need to be revised over time.
charter
new-uc-group-requirements
running-a-uc-election

View File

@ -55,5 +55,7 @@ the candidate.
Result
======
| Melvin Hillsman, Amy Marrich, and Yih Leong Sun were elected.
|\* Full Results: https://civs.cs.cornell.edu/cgi-bin/results.pl?id=E_f7b17dc638013045
Melvin Hillsman, Amy Marrich, and Yih Leong Sun were elected.
* Full Results: https://civs.cs.cornell.edu/cgi-bin/results.pl?id=E_f7b17dc638013045

View File

@ -52,5 +52,7 @@ the candidate.
Result
======
| Amy Marrich, Belmiro Moreira, and John Studarus were elected.
|\* Full Results: https://civs.cs.cornell.edu/cgi-bin/results.pl?id=E_8760d5969c6275f1&rkey=75d7d496f7e50780
Amy Marrich, Belmiro Moreira, and John Studarus were elected.
* Full Results: https://civs.cs.cornell.edu/cgi-bin/results.pl?id=E_8760d5969c6275f1&rkey=75d7d496f7e50780

View File

@ -1,6 +1,6 @@
========================
===========================
UC Elections September 2019
========================
===========================
We expect all members of our community to adhere to the highest
standards of behavior during User Committee elections.

View File

@ -1,5 +1,10 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
pytz>=2013.6 # MIT
PyYAML>=3.1.0 # MIT
docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain
sphinx>=2.0.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0

View File

@ -7,11 +7,3 @@ description-file =
author = OpenStack UC
author-email = user-committee@lists.openstack.org
home-page = https://governance.openstack.org/uc/
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
[pbr]
warnerrors = True

View File

@ -1,7 +0,0 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
# needed for doc build
docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain
sphinx>=1.5.0 # BSD
openstackdocstheme>=1.25.1 # Apache-2.0

View File

@ -4,18 +4,17 @@ minversion = 1.6
skipsdist = True
[testenv]
basepython = python3
usedevelop = True
passenv = ZUUL_CACHE_DIR
REQUIREMENTS_PIP_LOCATION
install_command = pip install {opts} {packages}
setenv = VIRTUAL_ENV={envdir}
deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt}
-r{toxinidir}/test-requirements.txt
-r{toxinidir}/requirements.txt
[testenv:venv]
commands = {posargs}
[testenv:docs]
commands = python setup.py build_sphinx
commands = sphinx-build -W -b html doc/source doc/build/html