From fd6b1c82f21a9374e33aaa0580618936eb6c7dc7 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Wed, 5 Jul 2017 02:04:34 +0900 Subject: [PATCH] Cleanup document formatting - Previously the title of the top page was Team and repository tags. It was completely wrong. - Remove spaces before URLs in CONTRIBUTING.rst. In openstackdocstheme, we have vertical lines for quote blocks. Removing unnecessary spaces improves the visibility of rendered HTML. - Use appropriate highlighting style for code blocks. Change-Id: Ib0d2e4699767e7b52b015c328c366202b3e5ddc8 --- CONTRIBUTING.rst | 9 +++------ README.rst | 33 ++++++++++++++++----------------- doc/source/index.rst | 3 ++- doc/source/user/usage.rst | 8 ++++---- 4 files changed, 25 insertions(+), 28 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 7075126..d4c243f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,16 +1,13 @@ If you would like to contribute to the development of OpenStack, you must follow the steps in this page: - - https://docs.openstack.org/infra/manual/developers.html +https://docs.openstack.org/infra/manual/developers.html Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at: - - https://docs.openstack.org/infra/manual/developers.html#development-workflow +https://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: - - https://bugs.launchpad.net/oslo.context +https://bugs.launchpad.net/oslo.context diff --git a/README.rst b/README.rst index 7c2aad6..5bfb284 100644 --- a/README.rst +++ b/README.rst @@ -1,24 +1,7 @@ -======================== -Team and repository tags -======================== - -.. image:: https://governance.openstack.org/badges/oslo.context.svg - :target: https://governance.openstack.org/reference/tags/index.html - -.. Change things from this point on - ==================== Oslo Context Library ==================== -.. image:: https://img.shields.io/pypi/v/oslo.context.svg - :target: https://pypi.python.org/pypi/oslo.context/ - :alt: Latest Version - -.. image:: https://img.shields.io/pypi/dm/oslo.context.svg - :target: https://pypi.python.org/pypi/oslo.context/ - :alt: Downloads - The Oslo context library has helpers to maintain useful information about a request context. The request context is usually populated in the WSGI pipeline and used by various modules such as logging. @@ -27,3 +10,19 @@ the WSGI pipeline and used by various modules such as logging. * Documentation: https://docs.openstack.org/developer/oslo.context * Source: https://git.openstack.org/cgit/openstack/oslo.context * Bugs: https://bugs.launchpad.net/oslo.context + +Team and repository tags +======================== + +.. image:: https://governance.openstack.org/badges/oslo.context.svg + :target: https://governance.openstack.org/reference/tags/index.html + +.. Change things from this point on + +.. image:: https://img.shields.io/pypi/v/oslo.context.svg + :target: https://pypi.python.org/pypi/oslo.context/ + :alt: Latest Version + +.. image:: https://img.shields.io/pypi/dm/oslo.context.svg + :target: https://pypi.python.org/pypi/oslo.context/ + :alt: Downloads diff --git a/doc/source/index.rst b/doc/source/index.rst index ec2f4f2..7bed79e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,6 +1,7 @@ .. include:: ../../README.rst -Contents: +Contents +======== .. toctree:: :maxdepth: 2 diff --git a/doc/source/user/usage.rst b/doc/source/user/usage.rst index ef01467..6f4dafa 100644 --- a/doc/source/user/usage.rst +++ b/doc/source/user/usage.rst @@ -21,7 +21,7 @@ Source: :ref:`example_usage_simple.py` **Example Logging Output:** -:: +.. code-block:: none 2016-01-20 21:56:29.283 8428 INFO __main__ [-] Message without context 2016-01-20 21:56:29.284 8428 INFO __main__ [req-929d23e9-f50e-46ae-a8a7-02bc8c3fd2c8 - - - - -] Message with context @@ -65,7 +65,7 @@ Source: :ref:`example_usage.py` **Example Logging Output:** -:: +.. code-block:: none 2016-01-21 17:30:50.263 12201 INFO __main__ [-] Message without context 2016-01-21 17:30:50.264 12201 INFO __main__ [req-e591e881-36c3-4627-a5d8-54df200168ef 6ce90b4d d6134462 - - a6b9360e] Message with context @@ -80,7 +80,7 @@ message. **Example Logging Output:** -:: +.. code-block:: none 2016-01-21 22:43:55.621 17295 INFO __main__ [req-ac2d4a3a-ff3c-4c2b-97a0-2b76b33d9e72 ace90b4d b6134462 - - c6b9360e] Message with passed context @@ -121,7 +121,7 @@ Source: :ref:`example_usage_user_identity.py` **Example Logging Output:** -:: +.. code-block:: none 2016-01-21 20:56:43.964 14816 INFO __main__ [-] Message without context 2016-01-21 20:56:43.965 14816 INFO __main__ [req-abc 6ce90b4d/d6134462@a6b9360e] Message with context