Commit Graph

25 Commits

Author SHA1 Message Date
gugug 7afd6c7e3f trivial: Drop references to os-testr
os-testr is dead. Long live stestr.

Change-Id: I8e5688e2a1ecc5fde96b059150cad6d9221fcd36
2020-09-09 09:06:34 +08:00
Andreas Jaeger 3fb93d566a 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.

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.

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.

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

Change-Id: I51fea3e1e954fd8fce782025d00aaf9dc396a68d
2020-05-22 17:21:15 +00:00
jacky06 9806db7899 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I754c795e3bcfcc3042b38cb57b01b7207e92083a
2019-04-26 09:25:22 +08:00
Zuul 414fa9d1d2 Merge "Fix docs cli authorize environment variables" 2018-04-03 01:30:04 +00:00
caishan 8354dd4291 Fix docs cli authorize environment variables
In Keystone v3, we need to set OS_USER_DOMAIN_NAME and
OS_PROJECT_DOMAIN_NAME as well. Use OS_PROJECT_NAME instead of
OS_TENANT_NAME.

Change-Id: I3b2c26929c394a877f5e3631a3807320ab55bde6
2018-03-26 20:58:55 -07:00
OpenStack Proposal Bot 1033849da8 Updated from global requirements
Change-Id: If5b50579c42bea88573a186e3b5edce3acbe2c65
2018-03-25 22:34:46 +00:00
Nguyen Hai 07132b21b3 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Remove the '[build_sphinx]' and related [pbr] sections as described in:
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I293930ebf2bbc5fe0025059e99fa92557c34b2a1
2018-03-24 13:19:53 +09:00
Yuanbin.Chen b120ede1b7 Add cli and contributor documents file.
Change-Id: I2a780d01bb08f7fdfb40a9ca7dc2ab126657e3ea
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
2018-03-07 12:06:47 +08:00
tengqm 0717dfb97f Retire senlin command line tool
With upstream osc-lib bug fixed, the --profile argument now works.
We have no need of the senlin command line. This patch retires the
command line.

Change-Id: I6bfc8f6f97ad7a77624ba5da1004a7a8f0924740
2017-12-13 07:51:22 -05:00
shangxiaobj 7f351334e6 Fix the ineffective url links in python-senlinclient docs
1)Find the ineffective url links in docs
2)Replace them with the right ones


Change-Id: I2e41a3056007c0c44289a2d51c0b870de15f6dda
2017-11-07 01:25:26 +00:00
tengqm 39c4dd0669 Add an installation doc
A quick doc for installation

Change-Id: I04702a3b665de506f9b3422ce8217537e8f6378d
2017-07-25 21:59:45 -04:00
bhavani.cr 216cfada46 Fix openstackdocstheme settings
To use openstackdocstheme 1.11.0 properly, this patch fixes
some settings according to follow.
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: Iefc14c0fba91e6ff442339278a510d64b2d42bff
2017-07-05 07:02:53 +00:00
Andreas Jaeger 05bff0cbc7 Cleanup sphinx building
remove unused sphinx extensions, tread warnings as errors.

Change-Id: I818caf827ebdd9fc95d340b8e5307368fe12d7da
2017-07-01 15:17:03 +02:00
Andreas Jaeger 4db08ce159 import cli-reference from openstack-manuals
This is part of the doc-migration work, see
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I2df59bf4ed296257e0032b46a49ef95d83194d2a
2017-07-01 11:32:07 +02:00
pallavi 2121b9e27c 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: I86b87e5672ad367b07d4f1000c5af8649ffcd0d2
Closes-Bug:#1693670
2017-06-09 14:50:16 +05:30
jolie ec26f24c27 Fixed warnings when building docs
This change fixes "WARNINGS" that were appearing when building
"tox -e venv -- python setup.py build_sphinx".

Change-Id: I97569b566b63f7e03fa18e891f2df3bdc76b79a8
Closes-Bug:#1664887
2017-02-15 17:57:03 +08:00
miaohb d70579c17d Remove unnecessary coding format in the head of files
The line of "coding utf8" is added by some editors automatically.
It's useless, can be removed.

Change-Id: Ieee4f43abc01ebadd3331bc86fded333b323873a
2017-01-04 17:58:42 +08:00
pawnesh.kumar 178232d38b Fix the incorrect version and release details
Change-Id: Ic550df6d99f1606207ac4ef8e097e03a13c02dfe
2016-10-08 01:23:26 +05:30
Thomas Bechtold a501fc872b 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: I1e8f1aa2ae9bd8ced8e5410488517547f0b29779
Closes-Bug: #1552251
2016-09-27 10:02:09 +02:00
jolie 47a83d5ee7 senlin profile-create has no argument -t
Change-Id: I86c6826fc053ea245a484c0bddaa7f34c5b3756d
2016-09-01 17:42:08 +08:00
zzxwill d1de6ec0d5 Removed the invalid link for Module Index
Same as bug 1538511, this also should be removed.

Change-Id: I0ea57e6f8274ee29e66b6d4494cd3255c1999685
2016-04-11 18:36:32 +08:00
LiuNanke a56b0f497c Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Closes-bug: #1529836
Change-Id: I78213d87e1180ade2babe42416e15d15aac1e59d
2016-01-09 22:20:40 +08:00
yanyanhu 5ca98c81d6 Revise comment format in doc to pass pep8 check
Change-Id: Icc2fa0c82cad0775e0d5ab4a562ec0cec1da0faa
2015-06-05 02:11:49 -04:00
tengqm 244357258e Fix initial gate errors
Change-Id: I8e7e0a65d658f5356a7e4e8436888d195bb53fe7
2015-03-21 18:42:25 +08:00
tengqm bc488792d1 Initial version 2015-01-04 17:59:59 +08:00