Commit Graph

10 Commits

Author SHA1 Message Date
Zuul ee780b7195 Merge "Add doc/requirements" 2024-01-31 00:27:30 +00:00
wangjiaqi07 66126c2a77 remove unicode from code
Change-Id: If44e9324df8b1cfc358ae3e378617a19f7c2de12
2022-08-25 14:22:36 +08:00
Hervé Beraud 8036700154 Add doc/requirements
Removing specific doc requirements from test-requirements.txt and move
them to a dedicated place.

Indeed, we need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].

The problem here is that this repos haven't doc/requirements.txt file
and by default in this case zuul will use the test-requirements.txt file
to pull requirements [4].

This requirements file contains extra requirements like flake8 that
collided with those allowed in our job environment and so the new pip
resolver fails to install these requirements and the job exits in error.

This project meet the conditions leading to the bug.

[1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html
[3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html
[4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36

Change-Id: Ibf838f01d935763ff1e0d19f10340c8ee360784c
2021-01-07 11:54:17 +01:00
Andreas Jaeger e5ae79051f Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

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: Id7a2401cd31c0b05812a76d2cc5f1e6a014cb510
2020-05-31 17:53:48 +02:00
Andreas Jaeger c127687d3d Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine;
  move contraints into deps
- Move python3 into base tox environment.

Change-Id: Ibd243ce5be8415147c24f596b4059ec3fb68a89c
2020-04-11 15:39:10 +02:00
Tom Barron 3a9c7fb9f7 doc migration: new directory layout
This patch introduces a new directory layout
in doc/source in conformance with the OpenStack
manuals project migration spec [1], moves the
existing content in manila/doc/source into the
new directories, and adjusts index files accordingly.

This is the first step in the migration process
as outlined in the spec.

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Partial-Bug: #1706181
Change-Id: I6b876f6e697659a5fe7046d5c5d4fd4ed98f9828
Needed-By: If13ebd1ede6fbc997d74425ec78e15621f1f80b2
Depends-On: I834fbef9783739fd664246ff710df1ab42ce2af5
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-08-21 08:30:25 -04:00
Tom Barron f829ae8e02 doc migration: openstackdocstheme completion
This patch completes the transition from oslosphinx
to openstackdocstheme in accord with the OpenStack
manuals project migration spec [1].

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Partial-Bug: #1706181
Needed-By: I6b876f6e697659a5fe7046d5c5d4fd4ed98f9828
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454

Change-Id: I834fbef9783739fd664246ff710df1ab42ce2af5
2017-08-21 08:29:00 -04:00
Arundhati Surpur ca2b39c444 Removes unnecessary utf-8 encoding
This patches removes unnecessary utf-8
encoding in doc/source/conf.py

Change-Id: I0159fec9ba3488931ffd6c39e3537335a8cec6f7
2017-07-05 10:54:07 +05:30
aditi 547ba3826d Remove link to modindex
The documentation build does not generate any module index, thus
remove the link to the page.

Change-Id: I2ded30fc69b5e1156fd05fa40674a0a3ab45a0ac
2017-01-27 12:39:56 +05:30
Igor Malinovskiy 50336185d9 Align project with default openstack project structure 2015-06-03 16:18:32 +03:00