Documentation from 7b1348a

index.html

@@ -27,6 +27,7 @@ <h2>Release Documentation</h2>
     <ul id="releases">
       <li><a href="v0.3.1">v0.3.1</a></li>
       <li><a href="v0.4.0">v0.4.0</a></li>
+      <li><a href="v0.4.1">v0.4.1</a></li>
     </ul>
     <h2>Trunk documentation</h2>
     <p>

v0.4.1/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 376588f1cd395ceb619f89fb98320647
+tags: 645f666f9bcd5a90fca523b33c5a78b7

v0.4.1/_sources/developer-information/api.rst.txt

@@ -0,0 +1,10 @@
+API Documentation
+=================
+
+This API documentation is generated from comments within the source code.
+
+.. autosummary::
+   :toctree: api
+   :recursive:
+
+   stylist

v0.4.1/_sources/developer-information/api/stylist.configuration.rst.txt

@@ -0,0 +1,36 @@
+stylist.configuration
+=====================
+
+.. automodule:: stylist.configuration
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      load_configuration
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      ConfigTools
+      Configuration
+
+
+
+
+
+
+
+
+

v0.4.1/_sources/developer-information/api/stylist.engine.rst.txt

@@ -0,0 +1,29 @@
+stylist.engine
+==============
+
+.. automodule:: stylist.engine
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      CheckEngine
+
+
+
+
+
+
+
+
+

v0.4.1/_sources/developer-information/api/stylist.fortran.rst.txt

@@ -0,0 +1,40 @@
+stylist.fortran
+===============
+
+.. automodule:: stylist.fortran
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      AutoCharArrayIntent
+      ForbidUsage
+      FortranCharacterset
+      FortranRule
+      IntrinsicModule
+      KindPattern
+      LabelledDoExit
+      MissingImplicit
+      MissingIntent
+      MissingOnly
+      MissingPointerInit
+      NakedLiteral
+
+
+
+
+
+
+
+
+

v0.4.1/_sources/developer-information/api/stylist.issue.rst.txt

@@ -0,0 +1,29 @@
+stylist.issue
+=============
+
+.. automodule:: stylist.issue
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Issue
+
+
+
+
+
+
+
+
+

v0.4.1/_sources/developer-information/api/stylist.rst.txt

@@ -0,0 +1,43 @@
+stylist
+=======
+
+.. automodule:: stylist
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+
+      StylistException
+
+
+
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   stylist.configuration
+   stylist.engine
+   stylist.fortran
+   stylist.issue
+   stylist.rule
+   stylist.source
+   stylist.style
+

v0.4.1/_sources/developer-information/api/stylist.rule.rst.txt

@@ -0,0 +1,31 @@
+stylist.rule
+============
+
+.. automodule:: stylist.rule
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      LimitLineLength
+      Rule
+      TrailingWhitespace
+
+
+
+
+
+
+
+
+

v0.4.1/_sources/developer-information/api/stylist.source.rst.txt

@@ -0,0 +1,41 @@
+stylist.source
+==============
+
+.. automodule:: stylist.source
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      CPreProcessor
+      CSource
+      FilePipe
+      FortranPreProcessor
+      FortranSource
+      PFUnitProcessor
+      PlainText
+      SourceFactory
+      SourceFileReader
+      SourceStringReader
+      SourceText
+      SourceTree
+      TextProcessor
+
+
+
+
+
+
+
+
+

v0.4.1/_sources/developer-information/api/stylist.style.rst.txt

@@ -0,0 +1,29 @@
+stylist.style
+=============
+
+.. automodule:: stylist.style
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Style
+
+
+
+
+
+
+
+
+

v0.4.1/_sources/developer-information/environment.rst.txt

@@ -0,0 +1,43 @@
+Create a Development Environment
+================================
+
+There are a number of different ways to create a suitable environment for
+Stylist development. A few are documented here.
+
+Whichever method you choose you will need to install certain packages. The
+ultimate arbiter of what is needed is the ``setup.cfg`` file.
+
+You will definitely need ``fparser`` and will probably want ``pytest``,
+``flake8`` and ``mypy``.
+
+Using a Virtual Environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Python supports cloning itself into stand alone instances at only the cost of
+all your disc space. Creating one of these instances is as easy as::
+
+    python3 -m venv ~me/place/which/i/like
+
+This can be performed using any version of Python you may have temporarily
+enabled using, for instance, environment modules. After the new virtual
+instance is created those modules should be unloaded to avoid potential
+confusion.
+
+Once created a virtual instance is "activated"::
+
+    source ~me/place/which/i/like/bin/activate
+
+This sets everything up and modifies your command-line prompt to give a
+reminder of which environment you are using. Once you are finished you can
+get rid of it all with::
+
+    deactivate
+
+Populating the Environment
+--------------------------
+
+With the virtual instance active you can use the "pip" tool to install
+anything you like from "pypi". These new libraries will not interact with
+any installed in any other virtual environments you may have created.
+
+e.g. ``python3 -m pip install pytest``

v0.4.1/_sources/developer-information/index.rst.txt

@@ -0,0 +1,31 @@
+Developer Information
+=====================
+
+Welcome to the "Stylist" code stye checking tool developer documentation.
+
+If you want to use the tool you may find the `User Guide`_ more to
+your taste.
+
+.. _User Guide: ../user-manual
+
+.. toctree::
+   :maxdepth: 2
+
+   overview
+   api
+   environment
+   rules
+   todo
+
+A lot of our process is dictated by the GitHub platform used to host the
+project. For details about that, such as how change requests are handled,
+see the `project wiki`_.
+
+.. _project wiki: https://github.com/MetOffice/stylist/wiki
+
+Indices and tables
+------------------
+
+* :ref:`modindex`
+* :ref:`genindex`
+* :ref:`search`