Add docs to fluent.syntax (#139)

Author: Pike

fluent.syntax/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+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)

fluent.syntax/docs/ast.rst

@@ -0,0 +1,8 @@
+AST & Tooling
+=============
+
+
+.. automodule:: fluent.syntax.ast
+   :members:
+   :exclude-members: scalars_equal
+   :show-inheritance:

fluent.syntax/docs/conf.py

@@ -0,0 +1,65 @@
+# 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 = 'Fluent Syntax'
+copyright = '2020'
+
+
+# -- 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 = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+]
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- 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 = 'nature'
+
+# 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']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/3/': None}
+
+# -- Options for autodoc extension -------------------------------------------
+
+autodoc_member_order = 'bysource'

fluent.syntax/docs/index.rst

@@ -0,0 +1,23 @@
+Fluent Syntax
+=============
+
+The :py:mod:`fluent.syntax` library is built for tooling around Fluent. It's
+designed to parse, analyze, process, and serialize Fluent files.
+
+The :py:mod:`fluent.syntax.ast` module implements ``Visitor`` and ``Transformer``
+patterns, which are the recommended interfaces to be used in analysis and
+post-processing of Fluent source files.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   reference
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

fluent.syntax/docs/parsing.rst

@@ -0,0 +1,7 @@
+Parsing
+=======
+
+.. py:module:: fluent.syntax.parser
+
+.. autoclass:: fluent.syntax.parser.FluentParser
+   :members: parse, parse_entry

fluent.syntax/docs/reference.rst

@@ -0,0 +1,20 @@
+API Reference
+=============
+
+The :py:mod:`fluent.syntax` module contains two helper methods.
+
+The :py:mod:`fluent.syntax.parser` and :py:mod:`fluent.syntax.serializer` modules
+provide more fine-grained control and detail.
+
+
+.. automodule:: fluent.syntax
+   :members:
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   parsing
+   ast
+   serializing

fluent.syntax/docs/serializing.rst

@@ -0,0 +1,5 @@
+Serializing
+===========
+
+.. automodule:: fluent.syntax.serializer
+   :members:

fluent.syntax/fluent/syntax/__init__.py

@@ -3,10 +3,14 @@
 
 
 def parse(source, **kwargs):
+    """Create an ast.Resource from a Fluent Syntax source.
+    """
     parser = FluentParser(**kwargs)
     return parser.parse(source)
 
 
 def serialize(resource, **kwargs):
+    """Serialize an ast.Resource to a unicode string.
+    """
     serializer = FluentSerializer(**kwargs)
     return serializer.serialize(resource)

fluent.syntax/fluent/syntax/parser.py

@@ -26,10 +26,17 @@ def decorated(self, ps, *args, **kwargs):
 
 
 class FluentParser(object):
+    """This class is used to parse Fluent source content.
+
+    ``with_spans`` enables source information in the form of
+    :class:`.ast.Span` objects for each :class:`.ast.SyntaxNode`.
+    """
     def __init__(self, with_spans=True):
         self.with_spans = with_spans
 
     def parse(self, source):
+        """Create a :class:`.ast.Resource` from a Fluent source.
+        """
         ps = FluentParserStream(source)
         ps.skip_blank_block()
 
@@ -73,13 +80,13 @@ def parse(self, source):
         return res
 
     def parse_entry(self, source):
-        """Parse the first Message or Term in source.
+        """Parse the first :class:`.ast.Entry` in source.
 
-        Skip all encountered comments and start parsing at the first Mesage
-        or Term start. Return Junk if the parsing is not successful.
+        Skip all encountered comments and start parsing at the first :class:`.ast.Message`
+        or :class:`.ast.Term` start. Return :class:`.ast.Junk` if the parsing is not successful.
 
         Preceding comments are ignored unless they contain syntax errors
-        themselves, in which case Junk for the invalid comment is returned.
+        themselves, in which case :class:`.ast.Junk` for the invalid comment is returned.
         """
         ps = FluentParserStream(source)
         ps.skip_blank_block()

fluent.syntax/fluent/syntax/serializer.py

@@ -19,12 +19,17 @@ def is_select_expr(elem):
 
 
 class FluentSerializer(object):
+    """FluentSerializer converts :class:`.ast.SyntaxNode` objects to unicode strings.
+
+    `with_junk` controls if parse errors are written back or not.
+    """
     HAS_ENTRIES = 1
 
     def __init__(self, with_junk=False):
         self.with_junk = with_junk
 
     def serialize(self, resource):
+        "Serialize a :class:`.ast.Resource` to a string."
         if not isinstance(resource, ast.Resource):
             raise Exception('Unknown resource type: {}'.format(type(resource)))
 
@@ -40,6 +45,7 @@ def serialize(self, resource):
         return "".join(parts)
 
     def serialize_entry(self, entry, state=0):
+        "Serialize an :class:`.ast.Entry` to a string."
         if isinstance(entry, ast.Message):
             return serialize_message(entry)
         if isinstance(entry, ast.Term):