Add documentation

ChangeLog.rst

@@ -0,0 +1,10 @@
+Changelog
+=========
+
+The format is based on `Keep a Changelog <http://keepachangelog.com/en/1.1.0/>`__.
+This project adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`__.
+
+v0.x.x - 20xx-xx-xx
+
+Added
+~~~~~

Credits.rst

@@ -0,0 +1,6 @@
+Credits
+=======
+
+The following people have contributed to **parsnip**:
+
+* Jen Bradley, University of Michigan - *Creator and lead developer*

README.rst

@@ -0,0 +1,85 @@
+.. _header:
+
+.. image:: _static/parsnip_header_dark.svg
+  :width: 600
+  :class: only-light
+
+.. image:: _static/parsnip_header_light.svg
+  :width: 600
+  :class: only-dark
+
+..
+  TODO: set up Readthedocs, PyPI, and conda-forge
+
+|ReadTheDocs|
+|PyPI|
+|conda-forge|
+
+.. |ReadTheDocs| image:: https://readthedocs.org/projects/parsnip-cif/badge/?version=latest
+   :target: http://parsnip-cif.readthedocs.io/en/latest/?badge=latest
+.. |PyPI| image:: https://img.shields.io/pypi/v/parsnip-cif.svg
+   :target: https://pypi.org/project/parsnip-cif/
+.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/parsnip-cif.svg
+   :target: https://anaconda.org/conda-forge/parsnip-cif
+
+
+.. _introduction:
+
+**parsnip** is a minimal Python library for parsing `CIF <https://www.iucr.org/resources/cif>`_ files. While its primary focus is on simplicity and portability, performance-oriented design choices are made where possible.
+
+The ``parsnip.parse`` module handles standard CIF files (including those under the `CIF 1.1 <https://www.iucr.org/resources/cif/spec/version1.1>`_ and `CIF 2.0 <https://www.iucr.org/resources/cif/cif2>`_ standards). It includes a table reader for `loop\_`-delimited tables as well as a key-value pair reader. Provide a filename and a list of keys to either of these functions and you're all set to read start parsing CIF files!
+
+
+.. TODO: reintroduce this text when the parsemm module is updated
+  ``parsnip.parsemm`` handles `mmCIF <https://www.iucr.org/resources/cif/dictionaries/cif_mm>` files.
+
+
+.. _installing:
+
+Setup
+-----
+
+**parsnip** may be installed with **pip** or from **conda-forge**.
+
+
+Installation via pip
+^^^^^^^^^^^^^^^^^^^^
+
+.. code:: bash
+
+    python -m pip install parsnip
+
+Installation via conda-forge
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code:: bash
+
+    conda install -c conda-forge parsnip
+
+
+Installation from source
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+First, clone the repository:
+
+.. code:: bash
+
+    git clone https://github.com/glotzerlab/parsnip.git
+    cd parsnip
+
+Then, choose one of the following. While **parsnip** is only dependent on Numpy,
+additional dependencies are required to run the tests and build the docs.
+
+.. code:: bash
+
+    pip install .            # Install with no additional dependencies
+    pip install .[tests]     # Install with dependencies required to run tests
+    pip install .[tests,doc] # Install with dependencies required to run tests and make docs
+
+Dependencies
+^^^^^^^^^^^^
+
+.. literalinclude:: ../../requirements.txt
+  :language: text
+
+.. _contributing:

doc/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     = source
+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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

doc/requirements.txt

@@ -0,0 +1,4 @@
+autodocsumm
+furo
+numpy>=1.19
+sphinx