specified pypi renderer

Author: sobester

ADRpy/mtools4acdc.py

@@ -1,12 +1,15 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-"""mtools4acdc.py:
-Miscellaneous tools to support aircraft engineering calculations
+"""
+.. _mtools4acdc_module:
+
+Miscellaneous Utilities
+-----------------------
 
-METHODS:
+This module contains miscellaneous tools to support aircraft
+engineering calculations.
 
-panelplot_with_shared_y, recastasnpfloatarray
 """
 
 __author__ = "Andras Sobester"

ADRpy/unitconversions.py

@@ -1,9 +1,15 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-"""unitconversions.py:
-A module containing conversion methods for units commonly used in
-aircraft engineering.
+"""
+.. _unitconversions_module:
+
+Unit Conversions
+----------------
+
+This module contains tools for converting between units commonly used in
+aircraft design.
+
 """
 
 __author__ = "Andras Sobester"

docs/source/conf.py

@@ -57,9 +57,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.1.0'
+version = '0.1.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.0'
+release = '0.1.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/index.rst

@@ -13,21 +13,35 @@ response to variations in ambient conditions.
 2. **Conceptual sizing methods** for fixed wing aircraft sizing (wing area and thrust/power
 requirements), given a set of constraints. These can be found in the :ref:`constraints_module`.
 
-3. **Utilities**
+3. **Utilities**, including a module for :ref:`unitconversions_module` and a set of 
+:ref:`mtools4acdc_module`.
 
 Installing and running ADRpy
 ----------------------------
 
-For the code and installation instructions see `the ADRpy GitHub 
-repository <https://github.com/sobester/ADRpy#aircraft-design-recipes-in-python>`_.
+On most systems you should be able to simply open an operating system terminal
+and at the command prompt type :code:`pip install ADRpy` or
+:code:`python -m pip install ADRpy` (:code:`pip` is a Python package: 
+if it is not available on your system, download `get-pip.py <https://bootstrap.pypa.io/get-pip.py>`_ 
+and run it in Python by entering :code:`python get-pip.py` at the operating system prompt).
+
+This is an open source project (released under a `GPLv3 <https://www.gnu.org/licenses/gpl-3.0.en.html>`_
+license) -- for the source code (and further installation instructions)
+see `the ADRpy GitHub repository <https://github.com/sobester/ADRpy#aircraft-design-recipes-in-python>`_.
 
 ADRpy Modules
 -------------
 
-.. automodule:: ADRpy.atmospheres
+.. automodule:: atmospheres
+    :members:
+
+.. automodule:: constraintanalysis
+    :members:
+
+.. automodule:: unitconversions
     :members:
 
-.. automodule:: ADRpy.constraintanalysis
+.. automodule:: mtools4acdc
     :members:
 
 * :ref:`genindex`

setup.py

@@ -22,6 +22,7 @@
     version=__version__,
     description='A Python library of aircraft conceptual design tools.',
     long_description=long_description,
+    long_description_content_type='text/markdown',
     url='https://github.com/sobester/ADRpy',
     download_url='https://github.com/sobester/ADRpy/tarball/' + __version__,
     license='GPLv3',