Browse Source

Updates after becoming an official projects

* Build documentation on docs.openstack.org
* Add badges, update README
* Adjust docs subdirs to match the standards

Change-Id: Ie4f51f994ef783c4924a6523fbdfe600fede6d12
Dmitry Tantsur 7 months ago
parent
commit
be21ac731b
8 changed files with 70 additions and 38 deletions
  1. 2
    1
      .gitignore
  2. 1
    3
      .zuul.yaml
  3. 10
    31
      README.rst
  4. 1
    0
      doc/requirements.txt
  5. 33
    0
      doc/source/cli/index.rst
  6. 12
    1
      doc/source/conf.py
  7. 10
    2
      doc/source/index.rst
  8. 1
    0
      tox.ini

+ 2
- 1
.gitignore View File

@@ -6,7 +6,8 @@
6 6
 
7 7
 # Sphinx
8 8
 _build
9
-doc/source/api/
9
+doc/source/reference/api/
10
+doc/source/.doctrees/
10 11
 
11 12
 # Packages/installer info
12 13
 *.egg

+ 1
- 3
.zuul.yaml View File

@@ -174,9 +174,7 @@
174 174
       - openstack-python36-jobs
175 175
       - openstack-lower-constraints-jobs
176 176
       - openstack-cover-jobs
177
-      - docs-on-readthedocs
178
-    vars:
179
-      rtd_webhook_id: '37378'
177
+      - publish-openstack-docs-pti
180 178
     check:
181 179
       jobs:
182 180
         - metalsmith-integration-glance-localboot-centos7

+ 10
- 31
README.rst View File

@@ -1,19 +1,22 @@
1 1
 Deployment and Scheduling tool for Bare Metal
2 2
 =============================================
3 3
 
4
+.. image:: https://governance.openstack.org/badges/metalsmith.svg
5
+    :target: https://governance.openstack.org/reference/tags/index.html
6
+
4 7
 Overview
5 8
 --------
6 9
 
7 10
 This is a simple tool to provision bare metal machines using `OpenStack Bare
8
-Metal Service (ironic) <https://docs.openstack.org/ironic/latest/>`_,
9
-`OpenStack Image Service (glance) <https://docs.openstack.org/glance/latest/>`_
10
-and `OpenStack Networking Service (neutron)
11
-<https://docs.openstack.org/neutron/latest/>`_.
11
+Metal Service (ironic) <https://docs.openstack.org/ironic/latest/>`_ and,
12
+optionally, `OpenStack Image Service (glance)
13
+<https://docs.openstack.org/glance/latest/>`_ and `OpenStack Networking
14
+Service (neutron) <https://docs.openstack.org/neutron/latest/>`_.
12 15
 
13 16
 * License: Apache License, Version 2.0
14
-* Documentation: https://metalsmith.readthedocs.io
17
+* Documentation: https://docs.openstack.org/metalsmith/
15 18
 * Source: https://git.openstack.org/cgit/openstack/metalsmith
16
-* Bugs: https://storyboard.openstack.org/#!/project/1000
19
+* Bugs: https://storyboard.openstack.org/#!/project/openstack/metalsmith
17 20
 
18 21
 Installation
19 22
 ------------
@@ -22,30 +25,6 @@ Installation
22 25
 
23 26
     pip install --user metalsmith
24 27
 
25
-CLI Usage
26
----------
27
-
28
-Generic usage is as follows::
29
-
30
-    metalsmith --os-cloud <CLOUD NAME> deploy --image <GLANCE IMAGE> \
31
-        --network <NEUTRON NET> --ssh-public-key <PATH TO SSH PUBLIC KEY> \
32
-        --resource-class <RESOURCE CLASS>
33
-
34
-This is an example suitable for TripleO (replace ``compute`` with the profile
35
-you want to deploy)::
36
-
37
-    source ~/stackrc
38
-    metalsmith deploy --image overcloud-full --network ctlplane \
39
-        --capability profile=compute --ssh-public-key ~/.ssh/id_rsa.pub \
40
-        --resource-class baremetal
41
-
42
-To remove the deployed instance::
43
-
44
-    metalsmith --os-cloud <CLOUD NAME> undeploy <NODE UUID>
45
-
46
-For all possible options see the built-in help::
47
-
48
-    metalsmith --help
49 28
 
50 29
 Contributing
51 30
 ------------
@@ -55,5 +34,5 @@ Contributing
55 34
   (see `developer's guide
56 35
   <https://docs.openstack.org/infra/manual/developers.html>`_)
57 36
 * Bugs and RFEs:  `StoryBoard
58
-  <https://storyboard.openstack.org/#!/project/1000>`_
37
+  <https://storyboard.openstack.org/#!/project/openstack/metalsmith>`_
59 38
   (please do NOT report bugs to Github)

+ 1
- 0
doc/requirements.txt View File

@@ -3,3 +3,4 @@
3 3
 # process, which may cause wedges in the gate later.
4 4
 sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
5 5
 sphinxcontrib-apidoc>=0.2.0  # BSD
6
+openstackdocstheme>=1.18.1 # Apache-2.0

+ 33
- 0
doc/source/cli/index.rst View File

@@ -0,0 +1,33 @@
1
+metalsmith CLI
2
+==============
3
+
4
+Deploy Command
5
+--------------
6
+
7
+Generic usage is as follows::
8
+
9
+    metalsmith --os-cloud <CLOUD NAME> deploy --image <GLANCE IMAGE> \
10
+        --network <NEUTRON NET> --ssh-public-key <PATH TO SSH PUBLIC KEY> \
11
+        --resource-class <RESOURCE CLASS>
12
+
13
+This is an example suitable for TripleO (replace ``compute`` with the profile
14
+you want to deploy)::
15
+
16
+    source ~/stackrc
17
+    metalsmith deploy --image overcloud-full --network ctlplane \
18
+        --capability profile=compute --ssh-public-key ~/.ssh/id_rsa.pub \
19
+        --resource-class baremetal
20
+
21
+Undeploy Command
22
+----------------
23
+
24
+To remove the deployed instance::
25
+
26
+    metalsmith --os-cloud <CLOUD NAME> undeploy <NODE UUID>
27
+
28
+See Also
29
+--------
30
+
31
+For all possible options see the built-in help::
32
+
33
+    metalsmith --help

+ 12
- 1
doc/source/conf.py View File

@@ -23,9 +23,15 @@ extensions = [
23 23
     'sphinxcontrib.apidoc',
24 24
 ]
25 25
 
26
+try:
27
+    import openstackdocstheme
28
+    extensions.append('openstackdocstheme')
29
+except ImportError:
30
+    openstackdocstheme = None
31
+
26 32
 autoclass_content = 'both'
27 33
 apidoc_module_dir = '../../metalsmith'
28
-apidoc_output_dir = 'api'
34
+apidoc_output_dir = 'reference/api'
29 35
 apidoc_excluded_paths = ['test']
30 36
 apidoc_separate_modules = True
31 37
 
@@ -71,6 +77,11 @@ pygments_style = 'sphinx'
71 77
 # html_theme = '_theme'
72 78
 # html_static_path = ['static']
73 79
 
80
+if openstackdocstheme is not None:
81
+    html_theme = 'openstackdocs'
82
+else:
83
+    html_theme = 'default'
84
+
74 85
 # Output file base name for HTML help builder.
75 86
 htmlhelp_basename = '%sdoc' % project
76 87
 

+ 10
- 2
doc/source/index.rst View File

@@ -8,12 +8,20 @@ The main entry point to the API is :py:class:`metalsmith.Provisioner`.
8 8
 .. toctree::
9 9
    :maxdepth: 3
10 10
 
11
-   api/metalsmith
11
+   reference/api/metalsmith
12 12
 
13 13
 .. toctree::
14 14
    :hidden:
15 15
 
16
-   api/modules
16
+   reference/api/modules
17
+
18
+Command-Line Interface
19
+----------------------
20
+
21
+.. toctree::
22
+   :maxdepth: 2
23
+
24
+   cli/index
17 25
 
18 26
 Ansible Role
19 27
 ------------

+ 1
- 0
tox.ini View File

@@ -26,6 +26,7 @@ commands =
26 26
   coverage combine
27 27
   coverage report -m --fail-under 90
28 28
   coverage html -d ./cover --omit='*test*'
29
+  coverage xml -o cover/coverage.xml
29 30
 
30 31
 [testenv:venv]
31 32
 deps =

Loading…
Cancel
Save