Skip to content

Commit

Permalink
unable to use testpypi, rst fix attempt
Browse files Browse the repository at this point in the history
  • Loading branch information
svenevs committed Sep 13, 2017
1 parent f4bdc61 commit 4303117
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 26 deletions.
47 changes: 22 additions & 25 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Exhale
|docs|

.. |docs| image:: https://readthedocs.org/projects/exhale/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://exhale.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
:scale: 100%
:target: https://exhale.readthedocs.io/en/latest/?badge=latest

.. begin_tmp_danger_warning
Expand All @@ -30,24 +30,24 @@ markup syntax / websites.

.. end_exhale_brief_desc
.. contents:: Contents
:local:
:backlinks: none

.. begin_exhale_long_desc
Exhale is a `Sphinx <http://www.sphinx-doc.org/en/stable/>`_ extension that depends on
Exhale is a `Sphinx <https://www.sphinx-doc.org/en/stable/>`_ extension that depends on
the excellent `Breathe`_ extension which enables parsing Doxygen documentation into the
Sphinx domain. Exhale provides a layer of automation, enabling launching Doxygen and
generating the full website all from your ``conf.py``. Exhale will execute these
actions by way of ``sphinx-build`` being invoked, allowing you to use it for hosting on
`Read the Docs <https://readthedocs.org/>`_. Exhale was designed for generating html
output, and may not be appropriate for other builders provided by Sphinx.

.. _Breathe: http://breathe.readthedocs.io/en/latest
.. _Breathe: https://breathe.readthedocs.io/en/latest

.. end_exhale_long_desc
.. contents:: Contents
:local:
:backlinks: none

See it in Action
----------------------------------------------------------------------------------------

Expand All @@ -69,21 +69,18 @@ HTML Theme choices:

.. _companion: https://github.com/svenevs/exhale-companion

.. _rtd: http://docs.readthedocs.io/en/latest/theme.html
.. _rtd: https://docs.readthedocs.io/en/latest/theme.html
.. _bstrap: https://ryan-roemer.github.io/sphinx-bootstrap-theme/
.. _alabaster: https://alabaster.readthedocs.io/en/latest/

.. |docs| image:: https://readthedocs.org/projects/my-favorite-documentation-test/badge/?version=latest
:alt: Sphinx RTD Theme Documentation Status
:target: http://my-favorite-documentation-test.readthedocs.io/en/latest/
:target: https://my-favorite-documentation-test.readthedocs.io/en/latest/

.. |bootstrap| image:: https://readthedocs.org/projects/my-favorite-documentation-test/badge/?version=bootstrap
:alt: Sphinx Bootstrap Theme Documentation Status
:target: http://my-favorite-documentation-test.readthedocs.io/en/bootstrap
:target: https://my-favorite-documentation-test.readthedocs.io/en/bootstrap

.. |alabaster| image:: https://readthedocs.org/projects/my-favorite-documentation-test/badge/?version=alabaster
:alt: Alabaster Theme Documentation Status
:target: http://my-favorite-documentation-test.readthedocs.io/en/alabaster
:target: https://my-favorite-documentation-test.readthedocs.io/en/alabaster

.. end_in_action
Expand All @@ -97,11 +94,11 @@ reStructuredText directives, and both `BeautifulSoup`_ and `lxml`_ for parsing t
generated Doxygen XML documentation. Exhale also uses `six`_ help account for the
Python 2 unicode dilemma. The easiest way to install Exhale is:

__ http://www.sphinx-doc.org/en/stable/extensions.html
__ https://www.sphinx-doc.org/en/stable/extensions.html

.. _BeautifulSoup: https://www.crummy.com/software/BeautifulSoup/bs4/doc/
.. _lxml: http://lxml.de/
.. _six: http://pythonhosted.org/six/
.. _lxml: https://lxml.de/
.. _six: https://pythonhosted.org/six/

.. code-block:: bash
Expand All @@ -126,7 +123,7 @@ of installing Exhale through other means, as it contains a ``setup.py``, but sin
seamlessly for Unix systems, but my understanding is Windows users may need to put a
little more effort in to get it to install.

__ http://lxml.de/installation.html
__ https://lxml.de/installation.html

.. end_installation
Expand All @@ -153,7 +150,7 @@ everything started.
**Why not use it?**
It may be more involved than you need. Check out the ``breathe-apidoc`` tool
that comes with your installation of ``breathe``. It is quite similar to the
`Sphinx API doc tool <http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html>`_,
`Sphinx API doc tool <https://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html>`_,
and that may be all you are looking for to get your documentation displayed.

If you are working with a small enough framework, you may also be satisfied with
Expand Down Expand Up @@ -344,9 +341,9 @@ There are some features I need to / want to implement this summer. I'm open to
suggestions / ideas / things you would want to see in this library. I'll be revamping
`exhale` this summer when I have a little more time.

The proposed changes are in the project roadmap_.
The proposed changes are in the project `roadmap <project_roadmap_>`_.

.. _roadmap: https://github.com/svenevs/exhale/projects/1
.. _project_roadmap: https://github.com/svenevs/exhale/projects/1

Credit
----------------------------------------------------------------------------------------
Expand All @@ -361,7 +358,7 @@ license:

1. For non-bootstrap, I used Stephen Morley's excellent and lightweight
collapsibleLists_ including the sample CSS / images on that post. He includes a
generous `CC0 license <http://code.stephenmorley.org/about-this-site/copyright/>`_
generous `CC0 license <https://code.stephenmorley.org/about-this-site/copyright/>`_
for these files, as well as the rest of his website.

For every HTML Theme I have tried, except for ones using bootstrap, this library
Expand All @@ -379,7 +376,7 @@ license:
Both of these libraries and copies of their licenses can be found in the
`data folder of the source code <https://github.com/svenevs/exhale/tree/master/exhale/data>`_.

.. _collapsibleLists: http://code.stephenmorley.org/javascript/collapsible-lists/
.. _collapsibleLists: https://code.stephenmorley.org/javascript/collapsible-lists/

__ https://github.com/jonmiles/bootstrap-treeview

Expand Down
2 changes: 1 addition & 1 deletion exhale/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

from __future__ import unicode_literals

__version__ = "0.1.2"
__version__ = "0.1.3"


def environment_ready(app):
Expand Down

0 comments on commit 4303117

Please sign in to comment.