Commit Graph

19 Commits

Author SHA1 Message Date
Ghanshyam Mann 31410355d4 Retire the python-searchlightclient project
As announced in openstack-discuss ML[1], Searchlight project
is retiring in Wallaby cycle.

This commit retires python-searchlightclient repository as per
process deinfed in project-guide[2]. Anyone would like to maintain
it again, please revert back this commit and propose the re-adding it
to governance.

The community wishes to express our thanks and appreciation to all of
those who have contributed to the python-searchlightclient project
over the years.

Depends-On: https://review.opendev.org/c/openstack/project-config/+/764519
Needed-By: https://review.opendev.org/c/openstack/governance/+/764530

[1] http://lists.openstack.org/pipermail/openstack-discuss/2020-November/018637.html
[2] https://docs.openstack.org/project-team-guide/repository.html#retiring-a-repository

Change-Id: If02fcc1c21abc9040a3b81cfa4973c7c6382ea15
2020-11-28 04:01:07 +00:00
Andreas Jaeger 983cae71c6 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 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_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.

Depends-On: https://review.opendev.org/728938
Change-Id: I6b95add07b469274ba1bf0070ba8c18b1795be41
2020-05-18 22:45:21 +02:00
Ghanshyam Mann d307e8e6ed [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

python-searchlightsclient 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: I37810f2e78523388a70cad0034f8d4d9e73e218b
2020-01-22 02:36:31 +00:00
sonpn13 9dc3e75201 Add PDF generation support for Python-SearchlightClient
Add PDF generation, fix wrong tag on index.rst

Change-Id: I1d0ba224ba1f0a0bd2157ccd45333f9a92871169
Signed-off-by: sonpn13 <sonpn13@viettel.com.vn>
Story: #2006118
Task: #35498
2019-10-31 18:26:16 +07:00
caoyuan 1b59e1dbb0 tox: Keeping going with docs
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.

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: I041acd7c63cf56ec9e90177a82ac0b37e15d4b12
2019-10-24 20:09:55 +08:00
jacky06 0f331ceb7c Sync Sphinx requirement
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Update some URLs to latest
3. Update the UPPER_CONSTRAINTS_FILE for tox[1]

[1]: http://lists.openstack.org/pipermail/openstack-discuss/2019-May/006478.html

Change-Id: Ief1980f0ff6c13ff0370b22267f2ef9baaa1ab64
2019-06-20 00:53:11 +08:00
Trinh Nguyen e2230a4759 Migrate to opendev.org
Change-Id: Iace98dcb3f15d2cd7aa2dcda2a76b3c77f81e6f7
Signed-off-by: Trinh Nguyen <dangtrinhnt@gmail.com>
2019-04-20 17:12:55 +09:00
Zuul abf46076fc Merge "Change launchpad to storyboard links" 2018-09-01 07:13:36 +00:00
OpenStack Proposal Bot ef19b71b8e Updated from global requirements
Change-Id: I4af49b0c0d2f6e486bcdbaffdcbfb61d3dca1c17
2018-09-01 14:52:22 +09:00
Nguyen Hai 7c08a38e0c Change launchpad to storyboard links
Change-Id: I91dd7fba45511400dfe8eb9580a3967ae4a0a480
2018-09-01 12:24:14 +09:00
Nguyen Hai 387ac35e57 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Remove [build_sphinx] section as described in:
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

This patch also changes minor things in doc.

Change-Id: Ib1c525d6a2f7e5477539155bfc3050b1905aad3e
2018-03-26 21:53:10 +09:00
Andreas Jaeger 859509fc05 switch to openstackdocstheme
Switch to current theme, tread sphinx warnings as errors.

See https://docs.openstack.org/openstackdocstheme/latest/ for the theme.

Change-Id: If71090d52b8d6b996adff2b614effbe7ace8acda
2017-07-01 15:37:59 +02:00
Andreas Jaeger 527e7abd57 Move existing content to fit new layout
This is part of the doc-migration work, see
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I7a681853e130d86d3e4c22a49df7f309b55459a2
2017-07-01 15:34:25 +02:00
gengchc2 7ce58d0656 Removes unnecessary utf-8 coding for python-searchlightclient
The file was added redundant utf-8 coding by some editor.
we can delete it .

Change-Id: I6b90f79dbd7a9f395c23a7a8ef1f84808be52898
2017-03-10 01:39:42 +00:00
Kevin_Zheng 85497f478f Add client doc details
Change-Id: Ib2eb0f2bc3f0234a4e5d15a5231d19a1bb2b9f76
2016-12-21 21:24:11 +08:00
Steve McLellan c3cf67f5e5 Remove circular TOC reference
The circular reference raises a warning with the current dependency
versions but oslosphinx >=4.0 seems to fail harder on it. Removing the
useless TOC and then empty Reference section.

Change-Id: Iac7d947b6a683f8cdb3b5378c9f82d70a1707d26
2016-10-03 11:05:08 -05:00
Andreas Jaeger 2a5d4e3e90 Update link to CLI Reference
The CLI Reference has been updated, adjust links to it.
Also fix spelling of OpenStack.

Change-Id: I48c2084a2d7e9d86fdf7b4fbec49635b6b811e94
2016-01-16 17:46:56 +01:00
liyingjun bcb1a14e14 Use seperate launchpad project for client
Use http://bugs.launchpad.net/python-searchlightclient
instead of http://bugs.launchpad.net/searchlight to track
releases of client.

Change-Id: I8cae98d87546dc841d0d3e361257350ea3fc0a08
2015-11-29 01:33:49 +08:00
liyingjun cb790b63af Init searchlightclient base
This patch includes:
1. client base
2. v1 resource type list client

Patial blueprint: openstack-client-search-initial-plugin

Change-Id: Ife57592cdff80cf6fa440dd2daba9daceefd3a11
2015-11-28 16:40:16 +08:00