Commit Graph

987 Commits

Author SHA1 Message Date
Tony Breeds 03c9bfc49e Retire Packaging Deb project repos
This commit is part of a series to retire the Packaging Deb
project. Step 2 is to remove all content from the project
repos, replacing it with a README notification where to find
ongoing work, and how to recover the repo if needed at some
future point (as in
https://docs.openstack.org/infra/manual/drivers.html#retiring-a-project).

Change-Id: Idad8685a3349aadc9b5287a17ac35bb1f888bcba
2017-09-12 16:09:27 -06:00
ChangBo Guo(gcb) 4fc2518539 Update URLs in documents according to document migration
Change-Id: I8018f0cc0b0f7642d9e0e65f14c9c8a8315b55b9
2017-07-13 12:16:24 +08:00
OpenStack Proposal Bot 68e64e8ea5 Updated from global requirements
Change-Id: I3b07be5b8ae0246de43adcba4e6d3e48fcee406e
2017-07-05 13:09:07 +00:00
Jenkins 372862c864 Merge "gitignore: Ignore .venv" 2017-07-05 12:36:08 +00:00
Jenkins 872ad9913c Merge "switch from oslosphinx to openstackdocstheme" 2017-07-03 15:45:42 +00:00
Jenkins bdd51c1ce2 Merge "turn on warning-as-error flag for doc build" 2017-07-03 15:31:47 +00:00
Stephen Finucane 87e1772430 gitignore: Ignore .venv
Change-Id: I740c9ec7cf91ab607a032253bd0d5c792fff4e40
2017-06-27 09:36:23 +01:00
Doug Hellmann bdc26f1303 switch from oslosphinx to openstackdocstheme
Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb
Change-Id: I58acb2cc35d33af586201a4667d82388a51987d5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-26 16:51:31 -04:00
Jenkins 823165d068 Merge "Trivial: Fix docstring" 2017-06-26 07:56:14 +00:00
Rajath Agasthya 87514e3e10 Trivial: Fix docstring
Why not?

Change-Id: Ibe98c901b788a2629e1ba794484a02096f54d0b1
2017-06-25 11:36:55 -07:00
Doug Hellmann f323413992 turn on warning-as-error flag for doc build
Change-Id: I5566cfa09dac8dec7a1bc32d95b42d5b136d726f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-22 16:08:39 -04:00
Doug Hellmann 2fa5003a05 rearrange existing documentation using the new standard layout
Change-Id: I885f1adf4fbfc1137c6c48039096bd7bdf89cbd3
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-22 16:08:39 -04:00
Jenkins 86ca01da6c Merge "docs: Don't specify pbr version in 'setup.py'" 2017-06-21 14:24:03 +00:00
Mehdi Abaakouk d43badb6c1 Restore previous IP binding
This commit 6fdf4e1086 have changed
the default binded ip, it binds one random interface on the system
instead of all. Break breaks all gate that expect the default to at
least listen on localhost.

This change restore the previous default.

Change-Id: I6323e66ea98d15c52b07c8e737fdd6f30aef0238
2017-06-20 15:43:40 +02:00
Stephen Finucane a20c108e43 docs: Don't specify pbr version in 'setup.py'
This is no longer the recommended practice.

Change-Id: Id61de0873e1599f7b5b6c63536266adb89c1fc3c
2017-06-20 10:52:34 +01:00
Doug Hellmann 3c059cb701 allow user to override the output location of api docs
Allow the user to specify 'api_doc_dir' in the build_sphinx section of
their setup.cfg to control where the auto-generated API documentation is
written.

Change-Id: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-15 12:41:49 -04:00
Doug Hellmann d3b2b79f23 fix tests based on API change in Sphinx
Upstream Sphinx now has some new expectations that are no longer being
met by some of our tests because we mock the constructor for the
application class. Fix the test to ensure the application instance has
the needed attributes.

Change-Id: Iad009ce74301c9ffd49ff2b2bab4afd9b7dd1388
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-13 16:52:05 -04:00
OpenStack Proposal Bot f62ebcb4b2 Updated from global requirements
Change-Id: Ibb7825bdfb03449f834498a88445dabb8bd71251
2017-05-21 22:13:47 +00:00
Jenkins c9a183b2c5 Merge "Ignore index URL lines in requirements.txt files" 2017-05-20 17:14:56 +00:00
A40351 6fdf4e1086 Add binding option for WSGI server
The packaged WSGI server currently only accepts a custom port.
This patch adds a new option to accept a custom interface. This is
useful in some cloud environments where there are restrictions on
which IP addresses are available to mount a server.

Change-Id: Iddf10bc422ae607b2d6bf2304dd032d7471ec458
2017-05-19 17:04:31 +08:00
Matthew Montgomery 2a0f2e589c Ignore index URL lines in requirements.txt files
Currently if an index is specified by either -i, --index-url or
--extra-index-url, the following error may be encountered when
setup is run.

Invalid requirement, parse error at "u'-i https'"

This patch ignores those lines in a requirements.txt file durning
parsing.

Closes-Bug: #1394999

Change-Id: Ie03f54ca7a7edad7a26fa1721f7b26532b65e760
2017-05-18 08:51:35 -05:00
Julien Danjou c02406601a builddoc: uses the new Sphinx 1.6 code for multiple builder
As noted by stephenfin, Sphinx 1.6 provides its own code to build doc with
multiple builders. The one provided by pbr so far for Sphinx < 1.6 is not even
compatible with 1.6. This patch fixes that by running the native Sphinx code
for Sphinx > 1.6 and falling back to the old code for older Sphinx versions.

Closes-Bug: #1691129
Change-Id: I5224235b1056a248b246c54e2d99eea94d53c4eb
2017-05-17 12:11:18 +02:00
OpenStack Proposal Bot 12a1c1dc3c Updated from global requirements
Change-Id: Ie230090ff923e84a8b4b3eca75bdc0b5a1405b15
2017-05-15 00:41:39 +00:00
Jenkins df95641103 Merge "Make oslosphinx optional" 2017-04-27 13:44:13 +00:00
Jenkins 53681bec0c Merge "trivial: Add note about multiple builders support" 2017-04-21 07:46:32 +00:00
Gage Hugo 2cf1d2eb18 Fix missing comment from previous change
In a previous commit [0] there was an additional character
escaping added at the end that was not added to the list
in the comment for the function. This change adds the missing
character to the list of escaped characters from the previous
change.

[0] https://review.openstack.org/#/c/439897/

Change-Id: I6e83a10ee51f1f18176bf2d17a0092d5a3cc4dd4
2017-04-18 10:24:02 -05:00
Stephen Finucane 0469bf39d4 trivial: Add note about multiple builders support
Sphinx 1.6 will support the definition of multiple builders in a
setup.cfg file like so:

  [build_sphinx]
  builder = html man

Once we support this version of Sphinx, we should stop carrying the
custom versions of this tooling we use.

Upstreaming things FTW.

Change-Id: Ibf2a003229a4585df96b09da7ca547e201c5aef5
2017-04-18 10:36:09 +01:00
Jenkins ca6e92c723 Merge "Stop building man pages by default" 2017-04-15 15:00:46 +00:00
Stephen Finucane 1ed8531095 Remove 'build_sphinx_latex'
codesearch.o.o shows a single, long-dead project using this [1]. Let's
just remove it and push people to set 'builders' instead in they really
want LaTeX.

[1] http://codesearch.openstack.org/?q=build_sphinx_latex

Change-Id: I820d9c540ae81717d7b33bbb4d2a4031b529b52c
2017-04-14 18:05:42 +00:00
Stephen Finucane d4e4efd779 Stop building man pages by default
From pretty much the beginning [1], pbr has defaulted to building both
man page and html output, but has failed to document it anywhere. People
tend to copy-paste their 'setup.py' and 'conf.py', or rely on the
'cookiecutter' project, with very little understanding of what's going
on under the hood (and why would you care - it's docs :)). This means
that the vast majority of folks using 'pbr' (basically everyone in
OpenStack) have been unwittingly building "man pages" as part of their
doc builds for no good reason, which has also led to a lot of confusion
when this magic behavior is the cause of bugs [2][3].

There's no good reason that pbr should default to building both man
pages and html output. For folks that want this functionality, we should
document it so they can use it. For everyone else though, let's do the
sane thing and output html like the standard 'build_sphinx' plugin.

[1] https://github.com/openstack-dev/pbr/commit/5b8b7f1d
[2] https://bugs.launchpad.net/pbr/+bug/1681983
[3] https://bugs.launchpad.net/oslotest/+bug/1379998

Change-Id: I579134a2b7980669180c1666503b848835cc2957
Closes-Bug: #1681983
2017-04-14 18:05:22 +00:00
Stephen Finucane 54fb6e71b7 docs: Use definition lists
These are far more concise and easier to read.

Change-Id: I411685b6e7d5385386b40cbf4b8bd4445b3c6847
2017-04-14 18:04:57 +00:00
Jenkins 5da68b9894 Merge "doc: Document Sphinx integration" 2017-04-14 06:25:13 +00:00
Doug Hellmann 84a8599133 add image.nonlocal_uri to the list of warnings ignored
pbr currently hard-codes the list of warnings that are to be ignored.
Many OpenStack projects use remote images to add project "badges" based
on tags defined in the governance repository. Ignore the warning caused
by using remote images so we can unbreak documentation builds using
those badges.

Change-Id: If47e3ca6519cc9f70d62cd887707321fe9199f81
Addresses-Bug: #1682467
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-04-13 11:51:55 -04:00
Jenkins b097ff1724 Merge "add changelog to published documentation" 2017-04-13 14:58:02 +00:00
Stephen Finucane b9c9630966 doc: Document Sphinx integration
This was briefly detailed before, but the variant of 'build_sphinx'
provided by 'pbr' does a lot for us that should be documented somewhere.

Change-Id: I0b1877c565d7771e7f0dfdf9198ff41bcd051dec
2017-04-12 14:44:30 +00:00
Jenkins d53ce060d4 Merge "Add Changelog build handling for invalid chars" 2017-04-11 17:36:09 +00:00
Doug Hellmann 16a0a98daa add changelog to published documentation
Include the ChangeLog content in the published documentation to make it
possible to read without downloading the source. Add a link to the new
page to the readme for discoverability.

Change-Id: I3cc06846b6d84f5b175a33a48838c8a6a5e1771d
Closes-Bug: #1681725
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-04-11 09:43:27 -04:00
Jenkins 5a21031398 Merge "Initialize sphinx config using application instead of config" 2017-03-30 18:19:42 +00:00
Clark Boylan 02228ceb21 Lazy import pkg_resources
pkg_resources is costly to import so don't import it until we actually
need it.

Change-Id: I2152b6b3fd47597b5af032e74a840e2f5b89c383
2017-03-28 11:00:16 -07:00
Jenkins f377238903 Merge "Remove testr entry point" 2017-03-27 23:12:29 +00:00
Gage Hugo 3cc5af104e Add Changelog build handling for invalid chars
This change adds new handling when building a Changelog file
for specific characters that cause documentation building
warnings/errors to be emitted when sphinx tries to generate
a Changelog html page. The changes include:

- Escaping any '*' in a commit, which sphinx will interpret as the
  start of a new line and throw a warning.
- Escaping any '_' in a commit, which in certain cases, sphinx will
  interpret as an invalid link and create an error.
- Escaping any '`' in a commit, which in certain cases will
  cause sphinx to interpet as a literal, and throw a warning.

After this change, any entries in the changelog that contain
the above "invalid" syntax no longer generate sphinx
warnings/errors and the offending entries now generate correctly.

Change-Id: I672ef4c56486e59a384849a4b182d11129726ae9
2017-03-27 11:37:24 -05:00
Alfredo Moralejo 2d7c0045f4 Initialize sphinx config using application instead of config
Currently sphinx config is initialized using sphinx.config,
however in recent versions of Sphinx, plugin specific parameters
as man_pages for man builder has been moved to the extension
and is not initialized from sphinx.config but using sphinx.application.
This is making man_pages to be empty when using sphinx 1.5 and man
builder is not properly called.

This patch initializes sphinx config using sphinx.application which
works fine with both old and new Sphinx versions.

Closes-Bug: #1674795

Depends-On: I7bde8fc1f2a7db5bd73635aa197377bf5ac614d2
Change-Id: Ib7c1a6fe8fbb5acfcfcfac61d0b53f080ff2b1e4
2017-03-27 08:46:47 +00:00
Thomas Bechtold ebd9ae850a Make oslosphinx optional
Avoid cyclic dependencies between pbr and oslosphinx. So if oslosphinx is not
available, continue to be able to generate the documentation.

Change-Id: I4c1f8ea5cded268388dab29931055223f8999c8a
2017-03-09 11:29:48 +01:00
Jenkins 6448d036f7 Merge "Also generate XML coverage report" 2017-03-08 17:24:27 +00:00
OpenStack Proposal Bot 013e9dd40a Updated from global requirements
Change-Id: I43344959288151b35983ed769898c149e64fff10
2017-03-02 23:52:51 +00:00
Ian Wienand 73ca7e086b Also generate XML coverage report
When using --coverage, also generate a machine-readable XML coverage
report.  This is useful to build tooling around automated tracking of
coverage results.

Change-Id: Idd54ecc627896cc5eab4903658f10a344bdb1778
2017-03-02 15:42:52 +11:00
Ian Wienand 629d14dbcb Update to a newer hacking library
The older hacking library has a cap on pbr <2.0, with the recent 2.0.0
release of PBR it's causing failures in the pep8 job. hacking isn't
kept in sync via the typical proposal-bot updates. Do it manually to
clear the gate issue.

Change-Id: I752f518611add90dd391982cb7dade9b599ff9d3
Related-Bug: #1668848
2017-03-02 15:42:51 +11:00
Stephen Finucane 882875a66e tox: Don't set skipsdist=True
skipsdist is used to "avoid expensive sdist" but prevents the software
package from being installed in the virtualenv. We currently have this
enabled, but then skip the step by including the current package in the
requirements section, which mitigates the entire thing.

Stop setting skipsdist to True, allowing us to remove '.' from
requirements and use tox the way it's meant to be used.

Change-Id: I543f0c6679c39c7ae438fd1e5fca7175b92ed193
2017-02-27 14:23:50 +00:00
Stephen Finucane 72e8e42a34 Stop using 'warnerrors'
This legacy option provided the ability to fail on doc warnings.
However, this functionality is broken in recent releases and now exists
in Sphinx itself (since 1.5.0). Rather that fixing it and causing a
whole load of doc build errors introduced in the time since this option
was broken, remove it, preferring the new Sphinx option instead.

This allows us to remove a lot of test code which is essentially testing
Sphinx functionality only now, based on the assumption that Sphinx do
adequate testing themselves.

Change-Id: Ia4b6adefcd437cb1ceb4558b004c17359df2486d
2017-02-27 14:20:57 +00:00
Stephen Finucane 028f82e6a7 doc: Clarify sections in 'setup.cfg'
Clarify what tools provide what sections in 'setup.cfg', thus explaining
why, for example, I couldn't find any references to '[build_sphinx]' in
either the pbr or setuptools source.

Comments are not a section, so this little bit of info is moved to a
'note'.

Change-Id: Icfb58195c58813e98ab48943119f53c7711331ec
2017-02-27 14:20:54 +00:00