Note semantic version to 2.0.0, update api docs

cfpb · Jun 3, 2014 · 6bceea4 · 6bceea4
1 parent 3d50940
commit 6bceea4
Show file tree

Hide file tree

Showing 6 changed files with 153 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,31 @@
+## 2.0.0
+
+* Definitions
+    * More accurate scoping rules
+    * "refers to" as a definition indicator
+    * When finding a defining term, highlight the *first* time that term appears in its defining paragraph (rather than the last)
+    * Defining multiple definitions at once (e.g. "X and B mean")
+    * Per-reg ignore lists
+* Appendices
+    * Better depth parsing for headers
+    * Better depth parsing for paragraphs
+    * Account for "notes"
+    * Allow for "code" tags
+* Interpretations
+    * Interpretations referring to multiple sections
+    * Allow for multiple interpretations for a single paragraph/section
+* Citations
+    * Only for existing paragraphs
+* SxS
+    * If the same section is referred multiple times by adjacent SxS headers, combine them
+    * Instead of duplicating SxS content when multiple citations are in a header, make a one-to-many relation
+* Versions
+    * Compile regulations from notices
+    * Low-level patching system for notice changes
+    * Allow notices to be manually modified (i.e. a bit higher-level patching)
+    * Allow notices to be split by date effective
+    * Spaces are added consistently to notice XML
+
 ## 12/31/2013
 
 * Better appendices

diff --git a/docs/regparser.layer.rst b/docs/regparser.layer.rst
@@ -12,6 +12,14 @@ regparser.layer.external_citations module
     :undoc-members:
     :show-inheritance:
 
+regparser.layer.formatting module
+---------------------------------
+
+.. automodule:: regparser.layer.formatting
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 regparser.layer.graphics module
 -------------------------------
 

diff --git a/docs/regparser.notice.rst b/docs/regparser.notice.rst
@@ -20,6 +20,46 @@ regparser.notice.build module
     :undoc-members:
     :show-inheritance:
 
+regparser.notice.build_appendix module
+--------------------------------------
+
+.. automodule:: regparser.notice.build_appendix
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+regparser.notice.build_interp module
+------------------------------------
+
+.. automodule:: regparser.notice.build_interp
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+regparser.notice.changes module
+-------------------------------
+
+.. automodule:: regparser.notice.changes
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+regparser.notice.compiler module
+--------------------------------
+
+.. automodule:: regparser.notice.compiler
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+regparser.notice.dates module
+-----------------------------
+
+.. automodule:: regparser.notice.dates
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 regparser.notice.diff module
 ----------------------------
 
@@ -28,6 +68,14 @@ regparser.notice.diff module
     :undoc-members:
     :show-inheritance:
 
+regparser.notice.encoder module
+-------------------------------
+
+.. automodule:: regparser.notice.encoder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 regparser.notice.sxs module
 ---------------------------
 

diff --git a/docs/regparser.rst b/docs/regparser.rst
@@ -32,6 +32,14 @@ regparser.api_writer module
     :undoc-members:
     :show-inheritance:
 
+regparser.builder module
+------------------------
+
+.. automodule:: regparser.builder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 regparser.citations module
 --------------------------
 
@@ -40,6 +48,14 @@ regparser.citations module
     :undoc-members:
     :show-inheritance:
 
+regparser.content module
+------------------------
+
+.. automodule:: regparser.content
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 regparser.federalregister module
 --------------------------------
 

diff --git a/docs/regparser.tree.depth.rst b/docs/regparser.tree.depth.rst
@@ -0,0 +1,46 @@
+regparser.tree.depth package
+============================
+
+Submodules
+----------
+
+regparser.tree.depth.derive module
+----------------------------------
+
+.. automodule:: regparser.tree.depth.derive
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+regparser.tree.depth.heuristics module
+--------------------------------------
+
+.. automodule:: regparser.tree.depth.heuristics
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+regparser.tree.depth.markers module
+-----------------------------------
+
+.. automodule:: regparser.tree.depth.markers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+regparser.tree.depth.rules module
+---------------------------------
+
+.. automodule:: regparser.tree.depth.rules
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: regparser.tree.depth
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/regparser.tree.rst b/docs/regparser.tree.rst
@@ -7,6 +7,7 @@ Subpackages
 .. toctree::
 
     regparser.tree.appendix
+    regparser.tree.depth
     regparser.tree.xml_parser
 
 Submodules
@@ -28,18 +29,18 @@ regparser.tree.interpretation module
     :undoc-members:
     :show-inheritance:
 
-regparser.tree.node_stack module
---------------------------------
+regparser.tree.paragraph module
+-------------------------------
 
-.. automodule:: regparser.tree.node_stack
+.. automodule:: regparser.tree.paragraph
     :members:
     :undoc-members:
     :show-inheritance:
 
-regparser.tree.paragraph module
--------------------------------
+regparser.tree.priority_stack module
+------------------------------------
 
-.. automodule:: regparser.tree.paragraph
+.. automodule:: regparser.tree.priority_stack
     :members:
     :undoc-members:
     :show-inheritance: