Tar ball without docs (#252)

* Trying to fix #210
1. Using if __name__ == "__main__" clause in example to avoid running them while generating docs
2. Trying to enforce PEP-8 compliant code + PYTHON2-3 compatibale code with examples as much as possible
3. Renaming examples with "-" to "_" for the ease of documentation generation
4. Minor changes  with setup and setup commands
5. Support documentation creation from make file
6. Remove unnecessary html and pdf files from the doc folder

* Fix makefile

* Remove unwanted files and folders from doc folder

* Add seperated requirements for Docs and add .readthedocs.yml

* Update requirements for docs

Author: dhoomakethu

.gitignore

@@ -23,3 +23,10 @@ test/__pycache__/
 **/pymodbus.db
 /.eggs/
 /.cache/
+/doc/sphinx/doctrees/
+/doc_new/
+/doc/quality/
+/doc/pymodbus.pdf
+/doc/sphinx/
+/doc/html/
+/doc/_build/

.readthedocs.yml

@@ -0,0 +1,9 @@
+# Build PDF & ePub
+formats:
+    - epub
+    - pdf
+requirements_file: requirements-docs.txt
+python:
+    extra_requirements:
+        - twisted
+        - documents

Makefile

@@ -16,7 +16,8 @@ default:
 	@echo '    make check      check coding style (PEP-8, PEP-257)'
 	@echo '    make test       run the test suite, report coverage'
 	@echo '    make tox        run the tests on all Python versions'
-	@echo '    make clean      cleanup all temporary files'
+	@echo '    make docs        creates sphinx documentation in html'
+	@echo '    make clean        cleanup all temporary files'
 	@echo
 
 install:
@@ -45,8 +46,8 @@ tox: install
 	@pip install --quiet tox && tox
 
 docs: install
-	@pip install --quiet sphinx
-	@cd doc/sphinx && sphinx-build -nb html -d doctrees . html
+	@pip install --quiet --requirement=requirements-docs.txt
+	@cd doc && make html
 
 publish: install
 	git push origin && git push --tags origin

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = PyModbus
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

doc/conf.py

@@ -0,0 +1,179 @@
+# -*- coding: utf-8 -*-
+#
+# PyModbus documentation build configuration file, created by
+# sphinx-quickstart on Wed Dec 20 12:31:10 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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
+parent_dir = os.path.abspath(os.pardir)
+# examples = os.path.join(parent_dir, "examples")
+example_contrib = os.path.join(parent_dir, "examples/contrib")
+example_common = os.path.join(parent_dir, "examples/common")
+example_gui = os.path.join(parent_dir, "examples/gui")
+
+sys.path.insert(0, os.path.abspath(os.pardir))
+sys.path.append(example_common)
+sys.path.append(example_contrib)
+sys.path.append(example_gui)
+# sys.path.extend([examples, example_common, example_contrib, example_gui])
+# sys.path.insert(0, os.path.abspath('../'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'PyModbus'
+copyright = u'2017, Sanjay'
+author = u'Sanjay'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'1.4.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.4.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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 = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PyModbusdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'PyModbus.tex', u'PyModbus Documentation',
+     u'Sanjay', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'pymodbus', u'PyModbus Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'PyModbus', u'PyModbus Documentation',
+     author, 'PyModbus', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

doc/sphinx/index.rst doc/index.rstdoc/sphinx/index.rst renamed to doc/index.rst

@@ -1,23 +1,24 @@
 .. PyModbus documentation master file, created by
-   sphinx-quickstart on Tue Apr 14 19:11:16 2009.
+   sphinx-quickstart on Wed Dec 20 12:31:10 2017.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
 Welcome to PyModbus's documentation!
 ====================================
 
-Contents:
-
 .. toctree::
    :maxdepth: 2
+   :caption: Contents:
+
+   readme.rst
+   changelog.rst
+   source/example/modules.rst
+   source/library/modules.rst
 
-   examples/index.rst
-   library/index.rst
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-