Switch from oslosphinx to openstackdocstheme

- Change to openstackdocstheme which is a theme and extension
support for Sphinx documentation that is published to
docs.openstack.org and developer.openstack.org.
- This patch also updates README.rst

Change-Id: I5922eb9b0f5835be65a5ba3eead78bdf92458452
This commit is contained in:
Nguyen Hai 2018-05-29 19:27:44 +09:00
parent 9e3a6157f0
commit 060361fb11
7 changed files with 17 additions and 14 deletions

@ -2,8 +2,8 @@
Team and repository tags Team and repository tags
======================== ========================
.. image:: http://governance.openstack.org/badges/heat-translator.svg .. image:: https://governance.openstack.org/tc/badges/heat-translator.svg
:target: http://governance.openstack.org/reference/tags/index.html :target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on .. Change things from this point on
@ -48,7 +48,7 @@ Project Info
------------ ------------
* License: Apache License, Version 2.0 * License: Apache License, Version 2.0
* Documentation: http://docs.openstack.org/developer/heat-translator/ * Documentation: http://docs.openstack.org/heat-translator/
* Launchpad: https://launchpad.net/heat-translator * Launchpad: https://launchpad.net/heat-translator
* Blueprints: https://blueprints.launchpad.net/heat-translator * Blueprints: https://blueprints.launchpad.net/heat-translator
* Bugs: https://bugs.launchpad.net/heat-translator * Bugs: https://bugs.launchpad.net/heat-translator

@ -21,8 +21,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx', 'openstackdocstheme'
'oslosphinx'
] ]
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -50,12 +49,7 @@ add_module_names = True
pygments_style = 'sphinx' pygments_style = 'sphinx'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------
html_theme = 'openstackdocs'
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = 'default'
# html_static_path = ['static']
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project

@ -1 +1,5 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst .. include:: ../../CONTRIBUTING.rst

@ -13,6 +13,7 @@ to HOT. However, the tool can be easily extended to support any non-heat
template format to produce HOT. template format to produce HOT.
Contents: Contents:
---------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -22,7 +23,7 @@ Contents:
contributing contributing
Indices and tables Indices and tables
================== ------------------
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`

@ -60,6 +60,7 @@ optional argument. The command below shows an example usage::
Alternatively, you can install a particular release of Heat-Translator as available at https://pypi.org/project/heat-translator. Alternatively, you can install a particular release of Heat-Translator as available at https://pypi.org/project/heat-translator.
In this case, you can simply run translation via CLI entry point:: In this case, you can simply run translation via CLI entry point::
heat-translator --template-file=translator/tests/data/tosca_helloworld.yaml --template-type=tosca heat-translator --template-file=translator/tests/data/tosca_helloworld.yaml --template-type=tosca
Things To Consider Things To Consider
@ -82,7 +83,9 @@ Things To Consider
This can be achieved by providing ``--deploy`` argument to the Heat-Translator. You can provide desired stack name by providing it as ``--stack-name <name>`` This can be achieved by providing ``--deploy`` argument to the Heat-Translator. You can provide desired stack name by providing it as ``--stack-name <name>``
argument. If you do not provide ``--stack-name``, an unique name will be created and used. argument. If you do not provide ``--stack-name``, an unique name will be created and used.
Below is an example command to deploy translated template with a desired stack name:: Below is an example command to deploy translated template with a desired stack name::
heat-translator --template-file translator/tests/data/tosca_helloworld.yaml --stack-name mystack --deploy heat-translator --template-file translator/tests/data/tosca_helloworld.yaml --stack-name mystack --deploy
* The Heat-Translator supports translation of TOSCA templates to Heat Senlin * The Heat-Translator supports translation of TOSCA templates to Heat Senlin
resources (e.g. ``OS::Senlin::Cluster``) but that requires to use a specific resources (e.g. ``OS::Senlin::Cluster``) but that requires to use a specific
TOSCA node type called ``tosca.policies.Scaling.Cluster``. TOSCA node type called ``tosca.policies.Scaling.Cluster``.

@ -35,6 +35,7 @@ msgpack-python==0.4.0
munch==2.1.0 munch==2.1.0
netaddr==0.7.18 netaddr==0.7.18
netifaces==0.10.4 netifaces==0.10.4
openstackdocstheme==1.18.1
openstacksdk==0.11.2 openstacksdk==0.11.2
os-client-config==1.28.0 os-client-config==1.28.0
os-service-types==1.2.0 os-service-types==1.2.0

@ -5,7 +5,7 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0
fixtures>=3.0.0 # Apache-2.0/BSD fixtures>=3.0.0 # Apache-2.0/BSD
oslotest>=3.2.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0
oslosphinx>=4.7.0 # Apache-2.0 openstackdocstheme>=1.18.1 # Apache-2.0
python-subunit>=1.0.0 # Apache-2.0/BSD python-subunit>=1.0.0 # Apache-2.0/BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
testrepository>=0.0.18 # Apache-2.0/BSD testrepository>=0.0.18 # Apache-2.0/BSD