The mock third party library was needed for mock support in py2
runtimes. Since we now only support py36 and later, we can use the
standard lib unittest.mock module instead.
Change-Id: I837241a34505496a3a152d72f28f23687ded1088
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.
Set openstackdocs_auto_name to use 'project' 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.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
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: I88d35727272813aa5371969e3ea3e763e1a12700
1. Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.
2. Remove the exists folder before run sphinx-build command
[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045
Change-Id: I1b1b45bf3ae104defbb16282e18995a28f67f649
First, the autodoc build is failing. Second, zun-ui is a horizon
plugin so auto-generated api docs don't seem to have much value.
This commit removes autodoc extension which basically stops
auto-generated API docs.
Change-Id: I3687a2b46fa524bb902bf8031c4d77945fb0c216
Closes-Bug: #1849990
Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
Change-Id: Id4eca6372cb3c9df048af11639b1159bb9451fa6
Closes-Bug: #1831517
Dependency for mox3 is fully removed. So this patch removes mox3
dependency from doc/requirements.txt
This should be cherry-picked into stable/rocky branch.
Change-Id: I708b0ac29dc686cec2d16a40281c04e1e61366d3
Horizon test setting no longer depends on nose and related stuffs.
This commit cleans up nose related dependencies.
The change was made in horizon Rocky-3,
so horizon 14.0.0.0b3 is required at least.
Change-Id: I616966db07033dded5a6de5e432b5876f015a234
Screen Shot:
https://drive.google.com/file/d/0B1UFZO9xX8eweERNX2FWVGRrMXM/view
Short Video:
https://youtu.be/lYt2U7qZG38
This patch realizes the Cloud Shell feature as following manner:
1. Add 'Cloud Shell' menu on the top menu bar.
2. When 'Cloud Shell' menu clicked, create console area on
the bottom of window.
3. If cloud shell container does not exists for the user,
create the container.
4. If cloud shell container exists, attach the console area
to the container.
5. Each time when attach to the container, clouds.yaml will be
exported into the container.
6. Password will be not imported into the container,
so user should set manually 'OS_PASSWORD' into envirinment
variables or 'password' into clouds.yaml.
Change-Id: Ia26be196758e5f3617b31750702a6c54436efb93
Depends-On: Ie4bc4d7302ce80ed9925db4156ff52f928460aca
This UI plugin has no specific configuration yet,
so this patch adds only link to Horizon's guide.
Also, fix title of linked documentation for contributor.
Change-Id: I459e44c58f9ff15f81b9327505a22cfbf4653c0d
zun-ui doc/source/conf.py has a custom logic which prepare index files
for autodoc, but now pbr and sphinx autodoc have a feature to do it and
it is no a good idea to keep the custom logic.
UI cookiecutter populates the custom logic and it is an example of
the clean up.
Change-Id: I6c6eb2f6292bda30a4fa8d4375defd8234463008
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: I5de43845fdd29a8fc6eddb6564c20da2a47c6581
Starting in Django 1.7, standalone scripts, such as a sphinx build
require that django.setup() be called first. See:
https://docs.djangoproject.com/en/1.8/releases/1.7/#standalone-scripts
It does not always necessary, but it is needed to avoid warnings
when creating autoindex.
Note that horizon no longer generates the autoindex to avoid warnings.
Drops setenv DJANGO_SETTINGS_MODULE in docs env in tox.ini.
DJANGO_SETTINGS_MODULE is configured in doc/source/conf.py,
so there is no need to pass envvar.
Add warning-is-error sphinx setting to avoid doc build warnings.
Change-Id: I4c036e264c7dd28463c3d52d73fcbbd3abeacb2b
Already we setup reno environment. So there were two Release notes
information: doc/source/releases and releasenotes (by reno).
Release Notes in doc directory are unnecessary.
It is not a good idea to have too much contents in the top page
document. Installation stuff is split into a separate page.
Title level of index.rst was inconsistent.
_static and _templates directories in releasenotes/source
are unnecessary. Also version info is set in release notes.
Change-Id: I0c2c31c9efc71d97ccea064da36302d886d8a743
To enable py35 tests, refresh test environments.
Also, update docs, remove run_tests.sh that is no longer used.
This patch needs to wait for adding python-zunclient into
global-requirements.
Change-Id: Ibed3eea72839226dca878d0ecd1778c9d9a7e7d3
