Commit Graph

28 Commits

Author SHA1 Message Date
Matthew Treinish
cd2fef95ca Add a .htaccess for redirecting old paths
This commit adds an .htaccess file to the tempest docs to handle
redirecting old paths to the new location. Before the docs migration in
the past we had docs located at docs.openstack.org/developer/tempest and
now things are located in docs.openstack.org/tempest/latest. With this
file we should be properly redirecting old links to the new location.

Change-Id: Idec7b2f299ade9b7dcc678ea1daf8daa25f08c44
2017-11-08 01:23:17 +00:00
Jenkins
5415c8ee83 Merge "[Doc] Remove html_use_smartypants config in doc" 2017-09-03 12:26:56 +00:00
yfzhao
6176f1bbf9 TrivialFix: Remove the unused import code
Remove the unused import code in doc/source/conf.py

Change-Id: Idd3de97e2752eb6a04b2040ea1dd88da5bb91b04
2017-08-03 20:16:13 +08:00
junboli
15b3842665 TrivialFix: Remove the unused import code
In the file doc/source/conf.py, some unused import code left, this change is to
clean them up.

Change-Id: I22ad2c3f6f37e0ca80c2a0d0943492572899929e
2017-07-31 15:32:19 +08:00
Masayuki Igawa
aa516f871f
Add flag to generate tempest plugin list
This commit adds a flag to generate a tempest plugin list. In a local
environment, we don't need to generate a tempest plugin list, always
when we just need to see the other documents. Besides, generating the
tempest plugin list takes a long time. When GENERATE_TEMPEST_PLUGIN_LIST
environment variable is 'true'(default), the plugin list is created.
When the other value such as 'false' is specified, it isn't.

Change-Id: I6fd3cb3045ba8bbfb39c597413e13faa3cd24ae3
2017-07-12 13:56:04 +09:00
bhavani.cr
29b2230828 Switch from oslosphinx to openstackdocstheme
To use openstackdocstheme 1.11.0 properly, this patch fixes
some settings according to follow.
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: I07652e3a086a650ab9f08f6da7ddf0e8145b2969
2017-07-04 11:01:33 +00:00
Masayuki Igawa
5febd73a50
[Doc] Remove html_use_smartypants config in doc
This commit removes 'html_use_smartypants' config in the doc conf.py.
The config option is already deprecated. And we don't need it in the
quoted double-dashes.

Change-Id: I1884abdb6bcab606879f4d90d604fdf2dee78c7d
2017-06-29 12:43:04 +09:00
zhanghongtao
60dc7a3a94 Fix html_last_updated_fmt for Python3.
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: If9104f4b56cd22fed87c596f990350ea877d83b6
Closes-Bug:#1693670
2017-06-09 09:21:07 +00:00
Masayuki Igawa
d2a657de0e
Update document theme and section headers
This commit updates the document theme. It is clear, simple, up-to-date
and beautiful. And this commit also updates section headers to fix the
document index.

Change-Id: Ia1e8e16e5f5ddb06e4c4ccb4979b0750b88a4db4
2017-05-09 15:34:45 -04:00
yuhui_inspur
cd420fb059 Add Apache License content in .py files
Change-Id: Iebd5844dc2b999f19264daf61d4b73dc85f42111
2017-04-11 01:47:43 -07:00
Stephen Finucane
d114804f1a Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.

There are a couple of small items to be cleaned up.

Change-Id: I01b1ac49c69d001ea25a475d903311d0b592656e
2017-03-23 11:51:45 +00:00
Stephen Finucane
e3701dd534 doc: Remove config for unused builders
Tempest doesn't build docs in any format except for HTML. We can remove
all of the cruft for other builders.

Change-Id: I0011e4bfdf6fdeb560e5f8a39a8077c80501c79e
2017-03-22 12:41:12 +00:00
gengchc2
831604c1da Removes unnecessary utf-8 coding
The file was added redundant utf-8 coding by some editor.
we can delete it .

Change-Id: I55cfca58af0985fb54f7f6307d96f99ae10bae35
2016-12-26 14:13:35 +08:00
Thomas Bechtold
89d56178b7 Fix doc build if git is absent
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.

Change-Id: Icfeb9354fff36776f5c83d3da3ab39ce2bb1dfb3
Closes-Bug: #1552251
2016-09-02 11:51:16 +00:00
Matthew Treinish
fc46326854
Add plugin registry generation to sphinx build
This commit adds running the plugin registry generation script to the
sphinx build. This ensure that every time we build the docs we'll have
an up-to-date plugin registry. This comes at the cost of increased
build time since the script will query openstack's git server to get
the plugin list. Also, the plugin-registry source file was added to
.gitignore since it is autogenerated now.

Change-Id: Ib26124c5d5d5ef4617e4e702e594ce7f1795ce23
2016-06-29 10:58:39 -04:00
Matthew Treinish
bdef1c77ab
Move oslo config generator config inside package
This commit moves the oslo config generator config file from living as
a data file, which makes it very difficult to rely on, to just living
in the package. By including it in the package we have a guaranteed
relative path we can rely on for building utilities on it, like the
tempest init command.

Change-Id: I5b9deae733f42fe3ed39418103304f71b43dccb3
Partially-implements: bp tempest-run-cmd
2016-06-22 14:39:42 -04:00
Masayuki Igawa
44ca9edd3b Disable SmartyPants for docs
This commit disables SmartyPants feature for docs because it renders
'--' to '–'(–) but it's not good for command options.

Change-Id: Ic5ef2c648e9e888dc8ce19c4038c39842b66cfd9
2016-06-10 09:25:48 +09:00
Harshada Mangesh Kakad
d11d5ee09d Fixing the deprecated library function.
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: I0751dbda085922d5e390cb7a19a9e832d399e20b
Partial-Bug: #1529836
2015-12-31 01:39:54 -08:00
David Paterson
0bf52d497b Fix init command
Init command was not working properly as it could not locate the
configuration sample file.
Steps taken:
- Move config-generator.tempest.conf to etc so it will be installed
with pbr.
- Update all files with new path to config-generator-tempest.conf as
needed.
- Refactor init command so if it detects we are not in a virtual
environment, try to find the global config directory /etc/tempest.
If that fails fallback to [sys.prefix]/etc/tempest.

Closes-Bug: #1491058
Closes-Bug: #1490670
Change-Id: I960bc711ff78ac2b0441ef63dff8ec4fb268fd3a
2015-09-23 09:42:07 -04:00
Matthew Treinish
1719dfeb69 Use the oslo.config sphinx module to generate sample
This commit switches to using the oslo.config sphinx extension to
generate a sample config instead of doing it manually in the docs'
conf.py module.

Change-Id: I7032cb4f56c728911ffa5c6911eb504f53bc80af
2015-08-25 14:21:43 +00:00
Matthew Treinish
13ed69fffc
Bake in oslo sample config generation to sphinx build
The expectation from users is that to build docs locally all you need
to do is run build_sphinx on the repo and the docs will be fully
created. When we added the sample config to the tempest docs we ignored
this and just added the sample config generation to the docs tox job.
This commit fixes this by baking in the sample config generation to
the sphinx conf.py file which should ensure we have the sample config
generated every time that we call build_sphinx.

Change-Id: Ifd570707847f52592f5bc9bc743b8d3c98512639
2015-08-11 10:13:03 -04:00
Christian Berendt
bf48dafdb3 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: Icdb04bbe9eb931b07e7363ebb852fa9e73b088ea
Related-Bug: #1368910
2014-09-25 10:06:42 +02:00
Dirk Mueller
82ba4286e0 Switch over to oslosphinx
oslosphinx is the new name of oslo.sphinx

Closes-Bug: #1277168
Change-Id: Ibfb9e59fbb3ef51a821b4f412601e26cb7f703f4
2014-02-14 18:16:53 +01:00
Matthew Treinish
271139aa7f Update to latest pbr
This commit moves switches tempest from the d2to1 version of pbr and
move to the latest version of pbr. However, there is a bug with
build_spinx so it doesn't work with a doc version set so that section
is removed from the doc conf.py.

Change-Id: I4fe14eb2b2e81132f8fa99936a031176b38c437b
2013-10-24 14:21:19 +00:00
Matthew Treinish
6d5c0528be Update docs config
This commit updates the docs conf.py to make it more closely resemble
what is used it other projects(based on nova's equivilent file). It
also removes listing Sean Dague as the sole author for the Tempest
docs because it is a collaborative effort. It also fixes a pep8
failure on the imports.

Change-Id: I535858dc9d413e8d5f92d44194137f615390d117
2013-09-25 14:09:46 +00:00
Michael Chapman
4410ca1c56 Fix index link in footer bar
bug 1192692

Sphinx isn't configured to load the tempest modules,
so the easiest fix is to remove the links to the
general and module indices (which don't exist).

Change-Id: Ic33e0b6ce56cb31fa51b4cdce25524d40191235d
2013-06-28 10:54:32 +10:00
Sean Dague
7679b488ed update docs for consistency
adjust the index file to be more readable for the field guide

adjust titles to make more sense when displayed in top level index

change theme to 'nature', which is closer to the openstack default
style. Will eventually write our own style here.

Change-Id: I4f5fed65f9e26a4e4d333b1be4ed02c9ec246b9a
2013-05-24 08:49:44 -04:00
Sean Dague
b56052b475 initial seed for tempest doc directory
This is a first bit of experiment to get a doc tree for tempest
that will publish our doc content to the web as part of a larger
QA doc guide.

Update some of the base READMEs to be a little more accurate,
now that we're going to be pushing them to the web.

Added tox [venv] to ensure that docs get built

Change-Id: Id54e8fbc1d884525087630106e17b37dc1206cc9
2013-05-22 21:06:55 -04:00