blob: 1d3ed2a1bb09fa104b56dbfecaa396d5c622b8de (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
===========================================================
Using oslosphinx.check_blueprints with Specs Repositories
===========================================================
The ``oslosphinx.check_blueprints`` extension verifies that the
filenames in spec repositories match a blueprint under a given
launchpad project.
Enabling
========
Add ``'oslosphinx.check_blueprints'`` to the ``extensions`` list in
the ``conf.py`` file in your Sphinx project.
Specifying the Launchpad Project
================================
Most projects should set ``check_blueprints_project`` to the name of
their launchpad project. This limits the search to the single project
named.
::
check_blueprints_project = 'nova'
Projects with multiple launchpad projects under their own project
group (such as Oslo), should instead set
``check_blueprints_project_group``. All projects in the group will be
scanned for each spec/blueprint name.
::
check_blueprints_project_group = 'oslo'
Checking Only the Current Release
=================================
By default, all files under ``specs/`` are checked. For large specs
repositories, this can take a long time. To limit the checks to a
subdirectory for the current release, set
``check_blueprints_release``.
For example::
check_blueprints_release = 'kilo'
will cause files under ``specs/kilo`` to be checked, and other files
to be ignored.
|
