Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updates to toctree
  • Loading branch information
janbridley committed Apr 7, 2024
commit fdddabeda2a1c6f3994188b51a7058752ec42890
Empty file added ChangeLog.rst
Empty file.
Empty file added Credits.rst
Empty file.
4 changes: 4 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
:target: https://anaconda.org/conda-forge/parsnip


.. _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!
Expand Down Expand Up @@ -79,3 +81,5 @@ Install Dependencies

.. literalinclude:: ../../requirements.txt
:language: text

.. _contributing:
24 changes: 23 additions & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,31 @@
.. include:: ../../README.rst


.. toctree::
:maxdepth: 2
:caption: Getting Started

introduction
installation
quickstart


.. toctree::
:maxdepth: 2
:caption: Contents:
:caption: API

package-parse


.. toctree::
:maxdepth: 1
:caption: Reference

genindex
development
changelog
credits
license


Indices and tables
Expand Down
8 changes: 8 additions & 0 deletions doc/source/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _installation:

Installation
===================

.. include:: ../../README.rst
:start-after: .. _installing:
:end-before: .. _contributing:
6 changes: 6 additions & 0 deletions doc/source/introduction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Introduction
===================

.. include:: ../../README.rst
:start-after: .. _introduction:
:end-before: .. _installing:
5 changes: 5 additions & 0 deletions doc/source/license.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
License
=======

.. literalinclude:: ../../LICENSE
:language: none
8 changes: 8 additions & 0 deletions doc/source/package-parse.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Parse Module
==============================

.. rubric:: Overview

.. automodule:: parsnip.parse
:members:
:show-inheritance: