Adding constraints support to libraries is slightly more complex than
services as the libraries themselves are listed in upper-constraints.txt
which leads to errors that you can't install a specific version and a
constrained version.
This change adds constraints support by also adding a helper script to
edit the constraints to remove os-api-ref.
Change-Id: I7ad1c2afda29b095ff3d53db5eec7101f8816c2e
This does a few things:
* Change from button list to a select combo box.
** This allows users to type the number they want
* Add the ablity to tag versions to releases
** E.G. Say mitaka was released with 2.27, it will
show in the list as "2.27 - Mitaka".
** This currently set as a config option in
conf.py as a dict like:
os_api_ref_release_microversions = {
'2.27' : 'mitaka',
'2.10': 'liberty'
}
* Uses https://github.com/danielfarrell/bootstrap-combobox
** Apache Licenced
Change-Id: Ica7dd55cdbf413f03ea635aefb627a705132a73e
We currently have a pending conflict over the Sphinx version in g-r,
so sync with g-r manually. Overall I would suggest that this project
should follow g-r
Change-Id: I0bf1af38945ba3e52098a925ea31f6f1dc3f3fbd
This causes a really odd vertical alignment issue. If we remove it
then the entire API line is vertically aligned.
Change-Id: I3fc2d4b234843ec226d75d5d4dd79055d33645b6
With very long URI paths the wrapping either
looks weird or there is no charecter for it to
wrap on.
This moves the URI to its own line, and moves some
of the other elements aroud slightly.
Also changes the font of the subtitle to make it more apparent.
Change-Id: I36e7420224f69eaa5f4dceb18d910b40377b76c4
-Tests warnings for missing and empty parameter files.
-Tests warnings when rest_parameter stanza lists
parameter file but no parameters.
Change-Id: Ic2c740a34964b1e23560102cc4e5c7fe0be63d50
This adds experimental support for a microversion selector. The
interface for this may well change over time. To currently use this we
need 2 values in the sphinx conf.py to specify min and max
microversions. If you don't have those added, nothing is changed in
the UI.
Use at your own risk. However it's much easier to get feedback if we
have this in the package.
Change-Id: Iaf7e117ea5792bb3b60c1fd0ae416b241ab89d65
This tracks the expanded list via a dedicated parameter, which expand
all fills up. It uses the history api to ensure that urls that users
create are sharable, including all the sections expanded correctly.
Change-Id: I10d03226b15c9d4b880c42fb3c2ae0c05d8fb8ac
The javascript code which is related to in page search is currently
unused. Remove it for now because it mostly adds to confusion about
what is important in this code.
Change-Id: I8d4ab47033b005596bc8430fb502673862eff1e1
Currently, when a parameter is formatted wrong sphinx dies with a
cryptic error message:
AttributeError: 'str' object has no attribute 'items'
This happens because the parameter is not recognized as dict.
This patch adds a check that ensures parameters are formatted correctly
by verifying that they're dicts.
Change-Id: I0140336cdcd9fd1d356d1fa50fd8dd15790ef8bd
-Added info on max_version field.
-Added info about including sample files.
-Added warning test for missing lookup key.
-Added warning test for missing type field.
Change-Id: I1ffa2d3e1d425239641adbdf029647e1af72bca0
This fixes the parsing of min_version and max_version in
parameters.yaml by treating things that look like floats as
strings. Otherwise 2.20 ends up folding to 2.2, which is definitely
not intentional.
This also adds a set of tests for microversion class setting in both
parameters in tables as well as in the method itself.
Change-Id: If2713fc4038e69d113cdaa7db0231a1d03f6223b
delete all the irrelevant parts of conf.py in the tests so it's clear
what is important and what is not.
Change-Id: I291c16bd754eff517d7db3ce228ced70936f454b
sphinx and sphinx_testing doesn't appear to be fully concurrent
safe. For now, lets just run in a single process.
Change-Id: I0b1bd24878a7641bc8c456141bf091b48c19619d
This creates an simple stab at a pattern for building testing for
os-api-ref. The basic theory is that we'll create a set of example
directories that are full doc trees with markup. We can then build
them and test the HTML output.
HTML output testing is done using BeautifulSoup so we can get
normalized HTML snippets regardless of whitespace and wrapping.
Change-Id: Idf582d62a4353db74b31183869f80bbf01b5d0f0
Most API Docs seem to colour code the HTTP methods to make
for easier reading.
This sets:
GET / HEAD - Blue
POST - Green
PATCH/PUT - Yellow
DELETE - Red
By reuseing some of the bootstrap label-* css.
Change-Id: Ic58edeb672ced1e66849c561133f272982abcb4e
I incorrectly assumed folks wouldn't diverge on the use of the in
value from where it was specified in the OpenAPI spec, but in looking
at the senlin code, I was wrong.
This produces a much more specific warning to explain what is wrong
with the parameters file.
Change-Id: Idffbd55dcd69d8f9ad988f74eb1b4be4b8a56667
Version added should be bold like the styling we add to microversion
added elements in the parameters tables.
Change-Id: I41cc96e6df4dd456cb2f56714922c108e8406aae
