From 89ab2b74496fd51186b13a71b832aa55de9aeede Mon Sep 17 00:00:00 2001 From: Mike Shoup Date: Tue, 1 Jan 2019 17:27:00 -0700 Subject: [PATCH] Updated documentation --- docs/Makefile | 20 ++++++ docs/conf.py | 160 ++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 24 +++++++ docs/installing.rst | 43 ++++++++++++ docs/license.rst | 16 +++++ docs/make.bat | 36 ++++++++++ docs/modules.rst | 7 ++ docs/synthale.rst | 46 +++++++++++++ docs/usage.rst | 2 + 9 files changed, 354 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/installing.rst create mode 100644 docs/license.rst create mode 100644 docs/make.bat create mode 100644 docs/modules.rst create mode 100644 docs/synthale.rst create mode 100644 docs/usage.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..905fa9b --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Synthale +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) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..d6c09db --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,160 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Synthale documentation build configuration file, created by +# sphinx-quickstart on Tue Jan 1 15:11:10 2019. +# +# 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 +sys.path.insert(0, os.path.abspath('../src')) + + +# -- 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 = 'Synthale' +copyright = '2019 Mike Shoup, documentation licensed with CC BY-SA 4.0' +author = 'Mike Shoup' + +# 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 = '0.0.1' +# The full version, including alpha/beta/rc tags. +release = '0.0.1' + +# 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 = '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 = {} + +# 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 = {} + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Synthaledoc' + + +# -- 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, 'Synthale.tex', 'Synthale Documentation', + 'Mike Shoup', '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, 'synthale', 'Synthale 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, 'Synthale', 'Synthale Documentation', + author, 'Synthale', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..3b060c0 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,24 @@ +Synthale +======== + +A python application to convert valid BeerXML_ files into Markdown files. You +can then use those Markdown files in your favorite static website generator. + +.. _BeerXML: http://www.beerxml.com/ + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + installing + usage + modules + license + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/installing.rst b/docs/installing.rst new file mode 100644 index 0000000..155ff24 --- /dev/null +++ b/docs/installing.rst @@ -0,0 +1,43 @@ +Installing +========== + +First thing's first, you need Python 3.5 or newer. Python 2 is not supported. + +Then, you can simply use pip to install Synthale: + +:: + + pip install synthale + +If that doesn't work, you may need to put `sudo` in front of your command. + +Some things to note, many (all?) Linux distributions still default to Python 2. +Python 2 is not supported. Ensure your `pip` command is using a new enough +version of Python by running `pip --version`: + +:: + + $ pip --version + pip 9.0.1 from /usr/lib/python2.7/dist-packages (python 2.7) + +This `pip` is installed using Python 2.7. If your `pip` is using Python 2, try +running the `pip3` command instead: + +:: + + $ pip3 --version + pip 9.0.1 from /usr/local/lib/python3.5/site-packages (python 3.5) + $ pip3 install synthale + +As long as `pip` succesfully installs Synthale, you can simply type the +`synthale` command to make sure it's installed: + +:: + + $ synthale + Usage: synthale [OPTIONS] INPUT_PATH OUTPUT_PATH + Try "synthale --help" for help. + + Error: Missing argument "INPUT_PATH". + +Now, move onto :doc:`usage` diff --git a/docs/license.rst b/docs/license.rst new file mode 100644 index 0000000..2a345cc --- /dev/null +++ b/docs/license.rst @@ -0,0 +1,16 @@ +License +======= + +Documentation +------------- + +Documentation is released under the `CC BY-SA 4.0`_ license. + +.. _CC BY-SA 4.0: https://creativecommons.org/licenses/by-sa/4.0/ + +Source Code +----------- + +The Synthale source code is released under the `GNU GPLv3`_ license. + +.. _GNU GPLv3: https://www.gnu.org/licenses/gpl-3.0.en.html diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..65d2d02 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=Synthale + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 0000000..0d9be14 --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +Code +==== + +.. toctree:: + :maxdepth: 4 + + synthale diff --git a/docs/synthale.rst b/docs/synthale.rst new file mode 100644 index 0000000..e74c192 --- /dev/null +++ b/docs/synthale.rst @@ -0,0 +1,46 @@ +synthale package +================ + +Submodules +---------- + +synthale\.cli module +-------------------- + +.. automodule:: synthale.cli + :members: + :undoc-members: + :show-inheritance: + +synthale\.convert module +------------------------ + +.. automodule:: synthale.convert + :members: + :undoc-members: + :show-inheritance: + +synthale\.markdown module +------------------------- + +.. automodule:: synthale.markdown + :members: + :undoc-members: + :show-inheritance: + +synthale\.recipes module +------------------------ + +.. automodule:: synthale.recipes + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: synthale + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000..9117611 --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,2 @@ +Using Synthale +==============