Commit Graph

24 Commits

Author SHA1 Message Date
Ghanshyam Mann 9321c5255a Update IRC network to OFTC
Change-Id: Ic0e0214f9b9522847cd01deeddf83870b279ec4c
2021-05-31 15:06:33 -05:00
liyou01 82ed0f3ba0 remove unicode from code
Change-Id: Ib37849cbcedc697bf15c84b726e05378ab1aed43
2021-01-07 10:38:32 +08:00
Andreas Jaeger 9995eee4c0 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.

Set openstackdocs_auto_name to use 'project' as name.

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.

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: I628af06b3702925bef790b3b3d1c47c2d7c7cbb0
2020-05-22 17:25:34 +00:00
Ghanshyam Mann 4f2a24dcc4 Fix typo in contributor guide
There are few typo in contributor guide which were
added recently.

Change-Id: I0c140c0afdd506c20ac109be893c7d50b1eda494
2020-04-22 21:54:05 -05:00
Ghanshyam Mann 772d75cc46 [ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html
Story: #2007236
Task: #38554

Change-Id: Ie02405c3b89b8d5f338191b7d8e58853186b4938
2020-04-19 17:56:05 -05:00
Andreas Jaeger 339f23dcf5 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 classifiers
- Use newer openstackdocstheme and Sphinx versions
- Cleanup */source/conf.py to remove now obsolete content.
- Remove install_command from tox.ini, the default is fine

Change-Id: Ib70fcdc751a1e84d3160558361a76bbd328f4625
2020-04-17 17:08:58 +02:00
Ghanshyam Mann 157f0c0ae7 [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

coverage2sql 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://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: I7e523bff1144d827dd1377c00d4a51512e265a85
2020-02-03 18:50:34 +00:00
Masayuki Igawa 1f3763636b
Add PDF documentation build
This commit adds PDF documentation build target 'pdf-docs' that will
build PDF versions of our docs. And this commit also updates 'docs'
target to use sphinx-build command as well as 'pdf-docs' target.

This is one of the Train community goals:

 https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Change-Id: Iae6bc9ae92fe61385c424923eaad35dc449880e9
Story: #2006070
Task: #35455
2019-10-02 18:48:31 +09:00
Masayuki Igawa 05bfc7613e
Update and fix docs conf.py
This commit updates and fixes the conf.py of documentation.

Change-Id: I23dbefa2a91417f5b2ce9b854dbfe4ab623aa6aa
2019-06-07 12:07:40 +09:00
Masayuki Igawa 75ad13d330
Separate requirements for documents tox job
This commit separates the requirements libraries for the docs job in
tox.ini. The latest sphinx doesn't work in Python2 environments anymore.
So, we need to split that into the test and docs jobs.

Change-Id: I7255cd9af0dfb5c1f66c1aa65d0ddfb144079836
2019-06-03 19:01:50 +09:00
Le Hou 9f1e5b4adf Use opendev repository
Change-Id: I688953064faafb12a1828795960cbeaecb606367
2019-04-23 17:16:38 +08:00
Zuul 7f3f36825b Merge "Introduce doc8" 2019-04-22 08:18:29 +00:00
Masayuki Igawa 85216dc2fb
Introduce doc8
This commit introduces doc8 package to sanity the documents. As a
result, one minor doc8 violations were found and fixed.

Change-Id: I0e9d6212536e59e438a14f632c4fc6016c31cc60
2019-04-18 16:34:13 +09:00
Masayuki Igawa c8415e0849
Add usage to README.rst and usage document
This commit adds an example usage to README.rst and usage document
for convenience.

Change-Id: Id1d6e58eea5f6f70568a1716f19add4d531f4ab1
2019-04-17 16:25:00 +09:00
zhangzs dec89a600f
replace http with https
Change-Id: I538bf4e38c798616e577bb78c2f98daf9eda59d3
2018-09-12 16:37:00 -06:00
XiaojueGuan eb9ef962de Update links in README
Change the outdated links to the latest links in README

Change-Id: I0c57f419bba60bf1a3f0356f0a65794e8994ce76
2018-06-12 15:22:40 +08:00
Masayuki Igawa 854f568830
Fix deprecated warning about use_html_smartypants config
This commit fixes the deprecated warning about 'use_html_smartypants'
config. We actually don't need to use it because when we quote command
line options, the conversion doesn't happen. So, this commit just
removes the config, and quotes the '--database-connection' option.

Change-Id: Ib1470e5f6febd08a9757a8773076faf3e9cd0eab
2017-06-29 12:25:06 +09:00
Jenkins af23bdcb0a Merge "rearrange existing documentation to follow the new standard layout" 2017-06-28 06:01:40 +00:00
Dong Ma 124a70fe02 Switch from oslosphinx to openstackdocstheme
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: I8a18f997aa1216fe8094265b8c0586c42d97b5ec
2017-06-28 06:02:40 +08:00
Masayuki Igawa c2324a7d22
Disable smartypants option
This commit disables the smartypants option of the document. We don't
need to convert quotes and dashes. And this commit also quotes the
--database-connection option. This should be better for the command
option description.

Change-Id: I79d3294eedf16085fa8c84d0ba203024cf80c181
2017-06-26 11:29:00 +09:00
Dong Ma be5c088604 rearrange existing documentation to follow the new standard layout
Change-Id: I97e3c740a1e96d45838fca9227712c602fec59b6
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-06-26 00:04:49 +08:00
Masayuki Igawa 20f1fb6f10
Update docs theme
This commit updates the docs theme to the new one. The new theme is the
standard of the openstack document. There is no reason to avoid to use
it.

Change-Id: If17ce35bd2ba50c3e1ae6e1567dcbe4be59d5189
2017-06-05 13:50:38 +09:00
Masayuki Igawa 9fcc9486f5
Update year of copyright
This commit just updates years of copyright. This project is started
from 2016 not 2013, and this is still continuing. So I just updated it.

Change-Id: I86c7ac14782d9e0e4775026363cfab2fdfbe7bca
2017-04-10 15:18:27 +09:00
Masayuki Igawa c5f72789a3 Initial Cookiecutter Commit. 2016-04-19 12:24:29 +09:00