Commit Graph

15 Commits

Author SHA1 Message Date
Riccardo Pittau 5e5e421ddd Update pep8 test requirements
Change-Id: I9a50f796b0b2ce762e1054a6b5e900ccd53bf796
2021-10-28 14:53:49 +02:00
Takashi Kajinami d9c167d070 Use importlib instead of imp
... because the imp module is deprecated since Python 3.4 .

Change-Id: Id6f2dd16b05090c0409cdab9d77d15eb8ce87ca9
2021-08-17 08:16:59 +09:00
wu.shiming 621cd8c129 remove unicode from code
In Python 3, all strings are represented in Unicode.In Python 2 are
stored internally as 8-bit ASCII, hence it is required to attach 'u'
to make it Unicode. It is no longer necessary now.'

Change-Id: I4d475c4ed3c79539c2bc383462f1ffca1e420520
2021-03-04 11:04:33 +08:00
Steve Baker 56066a20a4 Document metalsmith_instances
Change-Id: I9d3d17f104caea470252d400d26c225ca5de3b6e
2020-09-02 11:12:10 +12:00
Steve Baker 53636ba03c Move roles into a standard directory layout
This change adopts the same directory layout as tripleo-ansible[1]
in preparation for the metalsmith repo containing ansible plugins such
as modules.

Like in tripleo-ansible, the roles directory becomes a symlink to the
new roles location so that ansible can discover the role without
having to install.

[1] https://opendev.org/openstack/tripleo-ansible/src/branch/master/tripleo_ansible

Change-Id: I34114e653a0714cb5991672af1192e9fad95ea6b
2020-07-01 13:30:35 +12:00
Andreas Jaeger 7f25b01fb2 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I7843eced652e12d013a58b5254a356b2ed2f0a81
2020-05-21 20:23:40 +02:00
Andreas Jaeger 0236797717 Cleanup py27 support
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Update classifiers
- Update requirements, no need for python_version anymore

Change-Id: Iae9f2460b5274663119b5e82699e55277859f5e7
2020-04-05 18:08:09 +02:00
Iury Gregory Melo Ferreira 33871b187b Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

metalsmith is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal - https://review.opendev.org/#/c/691178/

Change-Id: Icf19488a3f230084faaf2ab5ece626b03495592e
2019-11-25 13:33:37 +01:00
Kaifeng Wang 386d5df557 Build pdf doc
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

Change-Id: Id2244fa8c70e8b8c09e309998012041883b98ab1
2019-09-06 10:56:57 +08:00
Dmitry Tantsur ce77bf8e1e Update Sphinx requirements to match global-requirements
Change-Id: I6e9a741d0d00c5b459c96c8288388abda819a573
2019-05-16 12:14:23 +02:00
Dmitry Tantsur 192b740d96 Add release notes
Change-Id: I99e5fa5596928c977826ac62e7408ec6629ec55d
2018-10-16 15:24:20 +02:00
Dmitry Tantsur be21ac731b Updates after becoming an official projects
* Build documentation on docs.openstack.org
* Add badges, update README
* Adjust docs subdirs to match the standards

Change-Id: Ie4f51f994ef783c4924a6523fbdfe600fede6d12
2018-09-21 14:09:39 +02:00
Dmitry Tantsur c91a08fb16 Simple role to deploy instances
Story: #2002170
Task: #20029
Change-Id: I3fc0ea5144b83262a39593c8211bd88ce90e13f8
2018-06-11 11:01:08 +02:00
Dmitry Tantsur 9a2fd614ca Install all dependencies when building docs
RTD cannot install several requirements files (SIGH), not does it use
pip to install projects (SIGH#2). This change creates a new requirement
file doc/joined-requirements.txt and links to both doc/requirements.txt
and root requirements.txt from it.

Note that we cannot put -r instructions to doc/requirements.txt since
it's managed by global-requirements.

Change-Id: Iaebf5917dc20d063e506a055d9f5af4daee0415b
2018-05-18 18:19:42 +02:00
Dmitry Tantsur 23fbeea112 Add docs generation (+ clean up)
Moved public access to exceptions from metalsmith itself to
metalsmith.exceptions to avoid clutterning the former.

Updated tox.ini to use upper-constraints.

Change-Id: I136e036749171dc6d36d644e79c6fcfeef6242af
2018-05-18 13:12:29 +02:00