Merge pull request #9 from ConorSheehan1/docs

Docs, closes #4

Author: ConorSheehan1

Pipfile

@@ -9,6 +9,7 @@ dev_osxdocker = "python osxdocker/docker_logs.py"
 dev_install = "flit install --symlink"
 tests = "python -m pytest tests"
 lint = "black ."
+build_docs= "sphinx-autobuild docs/source docs/build/html"
 # need ~/.pypirc setup
 publish_test = "flit publish --repository testpypi"
 publish = "flit publish"
@@ -20,10 +21,14 @@ flit = "*"
 pytest = "*"
 docker = "*"
 isort = {extras = ["pipfile"],version = "*"}
+sphinx = "==2.4.4"
+recommonmark = "*"
+sphinx-autobuild = "*"
 
 [packages]
 fire = "*"
 termcolor = "*"
+sphinx = "*"
 
 [requires]
 python_version = "3"

Pipfile.lock

@@ -103,3 +103,8 @@ pipenv run lint
 # to sort imports
 pipenv run isort -y
 ```
+
+#### Docs
+```bash
+pipenv run build_docs
+```

README.md

@@ -0,0 +1,6 @@
+To build docs
+```bash
+pipenv shell
+sphinx-apidoc -o . ../osxdocker
+make html
+```

docs/README.md

@@ -0,0 +1,7 @@
+osxdocker
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   osxdocker

docs/modules.rst

@@ -0,0 +1,30 @@
+osxdocker package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   osxdocker.utils
+
+Submodules
+----------
+
+osxdocker.docker\_logs module
+-----------------------------
+
+.. automodule:: osxdocker.docker_logs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: osxdocker
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/osxdocker.rst

@@ -0,0 +1,30 @@
+osxdocker.utils package
+=======================
+
+Submodules
+----------
+
+osxdocker.utils.docker\_base module
+-----------------------------------
+
+.. automodule:: osxdocker.utils.docker_base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osxdocker.utils.warn module
+---------------------------
+
+.. automodule:: osxdocker.utils.warn
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: osxdocker.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/osxdocker.utils.rst

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../.."))
+
+
+# -- Project information -----------------------------------------------------
+project = "osxdocker"
+copyright = "2020, Conor Sheehan"
+author = "Conor Sheehan"
+
+from osxdocker import __version__
+
+# The short X.Y version.
+version = __version__
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# -- General configuration ---------------------------------------------------
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "recommonmark",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autosummary",
+]
+
+autodoc_default_flags = ["members"]
+autosummary_generate = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+    "description": "A CLI for working with docker on OSX",
+    "fixed_sidebar": True,
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+from recommonmark.parser import CommonMarkParser
+
+source_parsers = {
+    ".md": CommonMarkParser,
+}
+
+# https://www.sphinx-doc.org/en/master/usage/markdown.html
+source_suffix = [".rst", ".md"]
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False

docs/source/conf.py

@@ -0,0 +1,23 @@
+.. TODO: README.md can't be added until https://github.com/sphinx-doc/sphinx/issues/7000 is resolved
+..   autosummary::
+..    :toctree: stubs
+   
+..    osxdocker.DockerLogs
+..    osxdocker.utils.DockerBase
+.. Does work but causes duplicate object description warnings
+.. If only using autosummary, class is missing from genindex
+.. If only using auoclass, class is missing from navigation in sidebar.
+
+
+osxdocker
+=====================================
+.. autosummary::
+   :toctree: modules
+
+    osxdocker.DockerLogs
+    osxdocker.utils.DockerBase
+    osxdocker.utils.warn
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:

docs/source/index.rst

@@ -0,0 +1,26 @@
+osxdocker.DockerLogs
+====================
+
+.. currentmodule:: osxdocker
+
+.. autoclass:: DockerLogs
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~DockerLogs.__init__
+      ~DockerLogs.cat_log
+      ~DockerLogs.clear_log
+      ~DockerLogs.log_path
+      ~DockerLogs.version
+   
+   
+
+   
+   
+