Add documentation module (#173)

chrisrink10 · web-flow · commit 1da2b48bf6fb · 2018-10-11T21:09:32.000-04:00
* Create a documentation module

* Add a small note about documentation being WIP
diff --git a/Makefile b/Makefile
@@ -11,6 +11,11 @@ release:
 	@pipenv run twine upload dist/*
 
 
+.PHONY: docs
+docs:
+	@pipenv run sphinx-build -M html "./docs" "./docs/_build"
+
+
 .PHONY: repl
 repl:
 	@BASILISP_USE_DEV_LOGGER=true pipenv run basilisp repl
diff --git a/Pipfile b/Pipfile
@@ -4,10 +4,12 @@ verify_ssl = true
 name = "pypi"
 
 [dev-packages]
-twine = "*"
+pytest-pycharm = "*"
+sphinx = "*"
+sphinx-rtd-theme = "*"
 tox = "*"
 tox-pyenv = "*"
-pytest-pycharm = "*"
+twine = "*"
 
 [packages]
 astor = "*"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ A Lisp dialect inspired by Clojure targeting Python 3.
 **Disclaimer:** _Basilisp is a project I created to learn about Python, Clojure,
 and hosted languages generally. It should not be used in a production setting._
 
-![PyPI](https://img.shields.io/pypi/v/basilisp.svg?style=flat-square) ![python](https://img.shields.io/pypi/pyversions/basilisp.svg?style=flat-square) ![CircleCI](https://img.shields.io/travis/chrisrink10/basilisp.svg?style=flat-square) ![Coveralls github](https://img.shields.io/coveralls/github/chrisrink10/basilisp.svg?style=flat-square) ![license](https://img.shields.io/github/license/chrisrink10/basilisp.svg?style=flat-square)
+![PyPI](https://img.shields.io/pypi/v/basilisp.svg?style=flat-square) ![python](https://img.shields.io/pypi/pyversions/basilisp.svg?style=flat-square) ![readthedocs](https://img.shields.io/readthedocs/basilisp.svg?style=flat-square) ![TravisCI](https://img.shields.io/travis/chrisrink10/basilisp.svg?style=flat-square) ![Coveralls github](https://img.shields.io/coveralls/github/chrisrink10/basilisp.svg?style=flat-square) ![license](https://img.shields.io/github/license/chrisrink10/basilisp.svg?style=flat-square)
 
 ## Getting Started
 
@@ -23,9 +23,10 @@ Once Basilisp is installed, you can enter into the REPL using:
 basilisp repl
 ```
 
-Basilisp features many of the same functions and idioms as [Clojure](https://clojure.org/)
-so you may find guides and documentation there helpful for getting
-started.
+Basilisp [documentation](https://basilisp.readthedocs.io) can help guide your 
+exploration at the REPL. Additionally, Basilisp features many of the same functions 
+and idioms as [Clojure](https://clojure.org/) so you may find guides and 
+documentation there helpful for getting started.
 
 ## Developing on Basilisp
 
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -0,0 +1,6 @@
+.. _cli:
+
+CLI
+===
+
+TBD
diff --git a/docs/compiler.rst b/docs/compiler.rst
@@ -0,0 +1,6 @@
+.. _compiler:
+
+Compiler
+========
+
+TBD
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,172 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 = 'Basilisp'
+copyright = '2018, Chris Rink'
+author = 'Chris Rink'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+# -- 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'
+
+# 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 pattern also affects 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 = None
+
+# -- 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 = {
+    "collapse_navigation": False
+}
+
+# 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.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Basilispdoc'
+
+# -- 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, 'Basilisp.tex', 'Basilisp Documentation',
+     'Chris Rink', '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, 'basilisp', 'Basilisp 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, 'Basilisp', 'Basilisp Documentation',
+     author, 'Basilisp', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# -- Extension configuration -------------------------------------------------
diff --git a/docs/features.rst b/docs/features.rst
@@ -0,0 +1,12 @@
+.. _features:
+
+Features
+========
+
+Here are a few of Basilisp's great features:
+
+* Immutable data structures, backed by `Pyrsistent <https://github.com/tobgu/pyrsistent>`_
+* Strong emphasis on functional programming concepts
+* Access to the vast array of existing Python libraries
+* Seamless :ref:`interoperability <python_interop>` between Python code and Basilisp code
+* Sophisticated :ref:`repl` for REPL-based development
diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
@@ -0,0 +1,34 @@
+Getting Started
+===============
+
+Basilisp is developed on `GitHub <https://github.com/chrisrink10/basilisp>`_ and hosted on `PyPI <https://pypi.python.org/pypi/basilisp>`_.
+You can fetch Basilisp using a simple::
+
+    pip install basilisp
+
+Once Basilisp is installed, you can enter into the REPL using::
+
+    basilisp repl
+
+In Basilisp's REPL, you now have the full power of Basilisp at your disposal.
+It is customary to write a ``Hello, World!`` when starting out in a new language, so we'll do that here::
+
+    user=> (print "Hello, World!")
+    Hello, World!
+    nil
+
+Or perhaps you'd like to try something a little more exciting, like performing some arithmetic::
+
+    user=> (+ 1 2 3 4 5)
+    15
+
+Sequences are a little more fun than simple arithmetic::
+
+    user=> (filter odd? (map inc (range 1 10)))
+    (3 5 7 9 11)
+
+There is a ton of great functionality built in to Basilisp, so feel free to poke around.
+Many great features from Clojure are already baked right in, and `many more are planned <https://github.com/chrisrink10/basilisp/issues>`_, so I hope you enjoy.
+From here you might find the documentation for the :ref:`repl` helpful to learn about what else you can do in the REPL.
+
+Good luck!
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,30 @@
+.. Basilisp documentation master file, created by
+   sphinx-quickstart on Fri Sep 14 08:39:59 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Basilisp's documentation!
+====================================
+
+.. note::
+
+   This documentation is incomplete and work is ongoing to improve it.
+
+Basilisp is a Lisp dialect inspired by Clojure targeting Python 3.
+
+Basilisp compiles down to raw Python 3 code and executes on the Python 3
+virtual machine, allowing natural interoperability between existing Python
+libraries and new Lisp code.
+
+Use the links below to learn more about Basilisp and to find help if you
+run into trouble using Basilisp.
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   features
+   gettingstarted
+   reference
diff --git a/docs/pyinterop.rst b/docs/pyinterop.rst
@@ -0,0 +1,6 @@
+.. _python_interop:
+
+Python Interop
+==============
+
+TBD
diff --git a/docs/reader.rst b/docs/reader.rst
diff --git a/docs/reference.rst b/docs/reference.rst
diff --git a/docs/repl.rst b/docs/repl.rst
diff --git a/docs/specialforms.rst b/docs/specialforms.rst

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +.. _cli:
++
 +CLI
 +===
++
 +TBD