summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-211-4/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * parallelizing building of documents Update Sphinx version as well. Remove the doc requirements from lower-constraints, they are not needed during installation. openstackdocstheme renames some variables, so follow the renames. A couple of variables are also not needed anymore, remove them. Set openstackdocs_pdf_link to link to PDF file. 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: Ic7c901ff19aa073b6e003ccb95aaf77886f20152
* Have middlewarearchitecture doc reference auth_type optionTim Burke2020-03-201-5/+5
| | | | | | | | | | | | | We literally say in (the rendered version of) the same doc: # Authentication type to load (string value) # Deprecated group/name - [keystone_authtoken]/auth_plugin #auth_type = <None> Looks like auth_plugin has been deprecated for quite some time: https://opendev.org/openstack/keystoneauth/commit/a56ed4218 Change-Id: I2dafa0cb28f017667497e0a6585d96a8cd090d5f
* Generate pdf documentationVishakha Agarwal2019-09-271-3/+16
| | | | Change-Id: I4bc8c036ce91795129970ab4f8c2536401c2a135
* Comment html_static_path entry in docs conf.pytrain-em7.0.1Gage Hugo2019-08-231-1/+1
| | | | | | | | | | | Currently with sphinx 2.2.0 the docs job is throwing a warning that the html_static_path entry does not exist. We treat warnings as errors so this causes the job to fail. This change comments the html_static_path entry in conf.py since the path currently does not exist so it appears to be unused. Change-Id: Ib2c74f4f37855cec250d09b23c45b5b7fde44c8d
* Bump the openstackdocstheme extension to 1.20pengyuesheng2019-08-021-14/+0
| | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: I161a3983e23b0ae50c232eb63ca78f8fd230e91e
* Add a new option to choose the Identity endpointJens Harbott2019-06-031-1/+2
| | | | | | | | | | | Previously the admin Identity endpoint was hardcoded to be used. Now that keystone has dropped v2 support, deploying an admin Identity endpoint is no longer useful, so allow this to be changed by the deployer. Keep the default as using the `admin` endpoint, but create a deprecation message so that we can change the default in the future. Partial-Bug: 1830002 Change-Id: I993a45ccb1109d67e65bf32d1e134cc9bec2d88e
* Trivial: Update pypi url to new urlmelissaml2018-12-161-2/+2
| | | | | | | | | Pypi url changed from [1] to [2] [1] https://pypi.python.org/pypi/<package> [2] https://pypi.org/project/<package> Change-Id: Ibb6247bfb2cfe1c77f6841be2773cbff9475e0c6
* Replace port 35357 with 5000Nguyen Van Duc2018-07-201-2/+2
| | | | | | | | | With Keystone v3, the admin (35357) and public (5000) ports are the same and use the same keystone code paths for authentication. This patch set replace 35357 and only uses port 5000 Change-Id: I596e3a2b29b2954bf7caef6f9408d9b2b4e890ee
* Document endpoint interface and region behaviorKristi Nikolla2018-07-051-0/+5
| | | | | | | | | | | | | | | | After some debugging following [0] to figure out why ksm was not connecting to the specified auth_url, found out that ksm connects to the identity server on the 'admin' interface [1] after authenticating with auth_url and fetching the catalog if keystoneauth is being used. Otherwise it connects on identity_uri and disregards the service catalog [2]. This behavior was not documented. [0]. http://eavesdrop.openstack.org/irclogs/%23openstack-keystone/%23openstack-keystone.2017-09-19.log.html#t2017-09-19T17:50:06 [1]. https://github.com/openstack/keystonemiddleware/blob/d1b7a1f0922419f956001f4bf14ad3e77449c860/keystonemiddleware/auth_token/__init__.py#L936-L938 [2]. https://github.com/openstack/keystonemiddleware/blob/d1b7a1f0922419f956001f4bf14ad3e77449c860/keystonemiddleware/auth_token/_auth.py#L121-L130 Change-Id: Ide40835de856012ac4dd71975beac9d32771f356
* Merge "Follow the new PTI for document build"Zuul2018-06-061-4/+12
|\
| * Follow the new PTI for document buildmelissaml2018-06-061-4/+12
| | | | | | | | | | | | | | | | | | | | 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 http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Co-Authored-By: Nguyen Hai <nguyentrihai93@gmail.com> Change-Id: Ia0a27229f09467980ff4af014001febb017bb36d
* | Merge "Don't rely on pbr ChangeLog for docs"Zuul2018-06-062-4/+2
|\ \
| * | Don't rely on pbr ChangeLog for docsColleen Murphy2018-05-242-4/+2
| |/ | | | | | | | | | | | | | | | | | | | | The ChangeLog file is generated when we run `python setup.py sdist`, which doesn't naturally happen when we run `tox -edocs`, so on a fresh clone the docs build will fail because it references the ChangeLog file which isn't there. Since we don't rely on pbr any more for release notes and we have a sophisticated release note management tool, point the docs at the published release notes instead of the pbr ChangeLog. Change-Id: I614091eae739154337795a8f120b68686ad0ed0a
* | Fix the title in index.rstwangxiyuan2018-05-251-0/+1
|/ | | | | | | The titles in the index.rst can't be shown in the webpage. This patch adds them back. Change-Id: I56febf6cb137b7f6dbc05365d48159be36d18c13
* Merge "Rename auth_uri to www_authenticate_uri"Zuul2017-10-201-1/+2
|\
| * Rename auth_uri to www_authenticate_uriColleen Murphy2017-10-111-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The [keystone_authtoken]/auth_uri middleware parameter has been causing extreme confusion amongst operators and developers ever since the keystonemiddleware started accepting keystoneauth plugin parameters including auth_url. The two parameters look identical and yet have completely different meanings and are both required. This patch deprecates auth_uri and renames it to www_authenticate_uri, which more accurately describes the WWW-Authenticate header it is configuring and is dissimilar to any other keystone_authtoken middleware parameter. This also renames the internal variable names for consistency with the config option. Change-Id: I0cf11da3d395749df28077427689fdafc8a6b981
* | Update config docs to reflect non-deprecated methodsJaewoo Park2017-09-111-3/+1
|/ | | | | | | | | Changed the keystone_authtoken part of the config docs so that it advertises the use of identity_uri over the deprecated auth_protocol, auth_port, auth_host Change-Id: Ia1351a83abed30f2680c2ce3a074028bd95158fb Closes-Bug: 1679238
* Merge "Add doc8 rule and check doc/source files"Jenkins2017-08-271-2/+2
|\
| * Add doc8 rule and check doc/source filesliuxiaoyang2017-08-261-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | doc8 is a linter for documents and used in openstack-manuals. It is better to enforce document linters for simple checking. This change is to add doc8 in tox file and fix line too long in some files. The current rules are as bellow: - invalid rst format - D000 - lines should not be longer than 79 characters - D001 - RST exception: line with no whitespace except in the beginning - RST exception: lines with http or https urls - RST exception: literal blocks - RST exception: rst target directives - no trailing whitespace - D002 - no tabulation for indentation - D003 - no carriage returns (use unix newlines) - D004 - no newline at end of file - D005 Change-Id: I01b11619b42eebf13cb17e1b4a2e8464a8ccc797
* | Remove notice about system timeColleen Murphy2017-07-281-9/+0
|/ | | | | | | | | | | Keystone used to require that the memcached and keystone servers both use UTC, but this was fixed[1]. Keeping the notice in the keystonemiddleware documentation is confusing. This patch removes the note. [1] https://bugs.launchpad.net/keystone/+bug/1221087 Change-Id: Iae2dc43ea3f0270246acd3184b7bb0c5778dcc7c
* Merge "Enable sphinx todo extension"Jenkins2017-07-241-0/+1
|\
| * Enable sphinx todo extensionGage Hugo2017-07-171-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | In a previous change [0] when warning-is-error was added, the sphinx todo extension was causing errors with duplicate registration. However with the recent changes between pbr and sphinx, this extension no longer throws a duplicate error when using warning-is-error and we can add it back in. [0] https://review.openstack.org/#/c/439819/ Change-Id: Ib71f156eb179bdfe07479441334ea0efcc594924
* | Update URLs in documentation4.17.0Hangdong Zhang2017-07-202-5/+5
|/ | | | | | Update URLs according to OpenStack document migration. Change-Id: Icb4232fcce79bb1ea121489122e578e3109b5e90
* Merge "Added "warning-is-error" sphinx check for docs"Jenkins2017-07-141-1/+0
|\
| * Added "warning-is-error" sphinx check for docsGage Hugo2017-04-241-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | This change adds the "warning-is-error" setting to setup.cfg in order to enforce strict doc validation which will cause the build to fail if any warnings are thrown. This also removes the redundant loading of the todo plugin warning that shows up while running 'tox -e docs' with 'warning-is-error' enabled. Change-Id: I33c110073feec7dd38ab75981d6f97c654852f37
* | Merge "Switch from oslosphinx to openstackdocstheme"Jenkins2017-07-071-11/+8
|\ \
| * | Switch from oslosphinx to openstackdocsthemeVan Hung Pham2017-06-301-11/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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: I5150a456df75d61035a6f00366fa70bd4ec83457
* | | Change locations of docs for intersphinxBoris Bobrov2017-07-051-1/+1
|/ / | | | | | | | | | | | | | | Due to latest change in docs the old urls don't work and cause gate failures. Fix it to reflect the new locations. Change-Id: I5b02d7fa40b5892ee0c66bba8dd642dde9a6637e Depends-On: I7e170275fd422345505b7282b52899d08c7a4172
* | Fix html_last_updated_fmt for Python3lingyongxu2017-06-091-2/+2
|/ | | | | | | | 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: I21ff7fe4da885d590303105c311aa9792fdaef2a
* Remove old comment referencing fixed bugGage Hugo2017-03-081-4/+0
| | | | | | | | | | | | | There was an old comment left regarding this bug: https://bugs.launchpad.net/pbr/+bug/1260495 which was fixed over a year ago but left over. This change removes the comment and related extension and adds the referenced pbr setting. Change-Id: Ib334c136835a9b5b43cabe13b9616cce45e578e0
* Fixed man_pages no value warning when making docsGage Hugo2017-02-081-1/+1
| | | | | | | | | | | | | When building keystonemiddleware docs, the following warning is currently emitted: WARNING: no "man_pages" config value found; no manual pages will be written This change comments out man_pages since it was only specifying an empty list, and the warning no longer appears. Change-Id: Ia650abc6cb3b3bcf36469cae9d8c20e83d0317a4
* Use https for *.openstack.org referencesEric Brown2017-02-053-5/+5
| | | | | | | The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I8521461203fe40e4576f4de7cfb500bd64027d6d
* Merge "Removes unnecessary utf-8 coding"Jenkins2017-01-171-2/+0
|\
| * Removes unnecessary utf-8 codingji-xuepeng2017-01-121-2/+0
| | | | | | | | Change-Id: I92884231ee5360873a55c29a928d3ef16bade441
* | fix broken linksSteve Martinelli2017-01-131-1/+1
|/ | | | | | | | | as noted in [1] we had a few broken links, this should fix the ones seen in the keystonemiddleware repo [1] http://lists.openstack.org/pipermail/openstack-docs/2017-January/009464.html Change-Id: I46a3e13ed78c4fca9a196089ceae994e41eff8bc
* clean up a few doc building warningsSteve Martinelli2016-12-151-0/+7
| | | | | | | | | | | | | Fixed two warnings: - keystonemiddleware/auth_token/__init__.py:docstring of keystonemiddleware.auth_token.BaseAuthProtocol.kwargs_to_fetch_token WARNING: Inline strong start-string without end-string. - keystonemiddleware/doc/source/api/modules.rst WARNING: document isn't included in any toctree Change-Id: Iaec9adb228fe9131365ab1c15d4c85567921ccdd
* Use extras for oslo.messaging dependencySteve Martinelli2016-06-282-0/+26
| | | | | | | | | | | | | | Install the oslo.messaging optional dependency by doing: keystonemiddleware[audit_notifications] pbr documentation: http://docs.openstack.org/developer/pbr/#environment-markers Partial-Bug: 1540115 Change-Id: I59eea1f7eb0e770ac4fe30211eff49ae76fb2550
* Fix typo 'olso' to 'oslo'bhagyashris2016-06-231-1/+1
| | | | | | TrivialFix Change-Id: I644bc36e3bf804c7546034ec8788671bd7cd01e6
* Clean up middleware architectureLance Bragstad2016-06-201-31/+35
| | | | | | | This commit attempts to clean up and shuffle some of the keystonemiddleware architecture document around to read a little easier. Change-Id: Icb0ad50ac67a35a50e5c2dd39324aa3e169e9dc9
* Merge "remove old options from documentation"4.5.0Jenkins2016-05-181-75/+0
|\
| * remove old options from documentationSteve Martinelli2016-05-121-75/+0
| | | | | | | | | | | | these config options are outdated and duplicated. remove them. Change-Id: I02ed459d46333406c394fbcc44d998ca8c2ac33e
* | Merge "generate sample config automatically"Jenkins2016-05-182-162/+7
|\ \ | |/
| * generate sample config automaticallySteve Martinelli2016-05-122-162/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Let's use sphinx extensions to generate the config options instead of updating them manually. The following options will no longer appear since we use auth plugins now: auth_admin_prefix auth_url auth_host auth_port auth_protocol identity_uri admin_token admin_user admin_password admin_tenant_name Change-Id: I0a6eac26f93bfb1c2cbba17a98629108915f78c6
* | Adding audit middleware specific notification driver confArun Kant2016-05-131-3/+22
|/ | | | | | | | | | | | | | | Now oslo messaging notifier can use driver information from audit middleware specific conf section. This allows audit to have different driver and transport usage from existing standard oslo messaging configuration. If audit middleware section is not defined, then existing logic is used which identifies driver from shared common oslo messaging notification conf section. Adjusted code and tests to recent oslo messaging notifier topic to topics arg change. And recent request.context change. Change-Id: Ia9ce654d3903efd0fd7893347e44ee27a765c745 Closes-Bug: 1544840
* Update config optionsMatt Fischer2016-05-041-5/+30
| | | | | | | | The config options in the architecture page needed to be updated. This includes new values and correct text for old values. We also note in the code that the revocation event list is only valid for PKI tokens. Change-Id: Ib98d3de771d88feea72ea9598d094b77cde6093e
* Fix doc build if git is absentThomas Bechtold2016-04-131-2/+7
| | | | | | | | | 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: Ic2a6031a9b098e39c95669ca6fa2b92e536dc2ad Closes-Bug: #1552251
* Update documentation for running testsBrad Pokorny2016-02-251-1/+2
| | | | | | | | | The documentation for how to run tests currently says to use "python setup.py test", which results in errors. Update the docs to specify tox. Change-Id: Ib32f6c0708de9439b6bdee4a4fb56cb88bc47d5a Closes-Bug: #1550068
* Replace deprecated library function os.popen() with subprocessLiuNanke2016-01-131-2/+5
| | | | | | | | os.popen() is deprecated since version 2.6. Resolved with use of subprocess module. Closes-bug: #1529836 Change-Id: I3f78fff64f100aa7d435c830a2a913a521af698e
* Merge "Configuration is outdated"Jenkins2015-12-181-3/+17
|\
| * Configuration is outdatedDave Chen2015-12-081-3/+17
| | | | | | | | | | | | | | | | | | Part of configuration options have been deprecated, the doc need sync with this change, this patch also add the configuration option `identity_uri` and `auth_url` in the example. Change-Id: I1994d899c4dae47412983781647ed5865bdaf6eb Closes-Bug: #1422432
View Lorry Controller Status