Skip to content

Commit

Permalink
start updating nettlesome links in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mscarey committed Mar 8, 2021
1 parent d56127a commit b65ab4f
Show file tree
Hide file tree
Showing 23 changed files with 429 additions and 484 deletions.
16 changes: 9 additions & 7 deletions authorityspoke/decisions.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,22 @@ class Decision(Comparable):
the `Caselaw Access Project API <https://api.case.law/v1/cases/>`_.
One of these records may contain multiple :class:`.Opinion`\s.
Typically one record will contain all the :class:`.Opinion`\s
Typically one record will contain all
the :class:`~authorityspoke.opinions.Opinion`\s
from one appeal, but not necessarily from the whole lawsuit. One
lawsuit may contain multiple appeals or other petitions, and
if more then one of those generates published :class:`.Opinion`\s,
the CAP API will divide those :class:`.Opinion`\s into a separate
if more then one of those generates published Opinions,
the CAP API will divide those Opinions into a separate
record for each appeal.
The outcome of a decision may be determined by one majority
:class:`Opinion` or by the combined effect of multiple Opinions.
:class:`~authorityspoke.opinions.Opinion` or by the combined
effect of multiple Opinions.
The lead opinion is commonly, but not always, the only
:class:`.Opinion` that creates binding legal authority.
Usually every :class:`.Rule` posited by the lead :class:`.Opinion` is
Opinion that creates binding legal authority.
Usually every :class:`~authorityspoke.rules.Rule` posited by the lead Opinion is
binding, but some may not be, often because parts of the
:class:`.Opinion` fail to command a majority of the panel
Opinion fail to command a majority of the panel
of judges.
Expand Down
2 changes: 1 addition & 1 deletion authorityspoke/io/api_spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def make_spec() -> APISpec:
"""Generate specification for data used to create AuthoritySpoke objects."""
holding_spec = APISpec(
title="AuthoritySpoke Holding API Schema",
version="0.1.0",
version="0.2.0",
openapi_version="3.0.2",
info=dict(description="An interface for annotating judicial holdings"),
plugins=[MarshmallowPlugin()],
Expand Down
1 change: 1 addition & 0 deletions changelog.md → changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Changelog
dev
------------------
- Import Nettlesome library as dependency
- Remove "anchors" fields from Factors in AuthoritySpoke Holding API Schema

0.5.0 (2021-01-25)
------------------
Expand Down
5 changes: 0 additions & 5 deletions docs/api/context.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/api/explanations.rst

This file was deleted.

15 changes: 0 additions & 15 deletions docs/api/factors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,6 @@
Factors
==============

.. autoclass:: authorityspoke.factors.Factor
:members:
:special-members:

Entities
==============

.. inheritance-diagram:: authorityspoke.entities.Entity
:top-classes: authorityspoke.comparisons.Comparable
:parts: 1

.. autoclass:: authorityspoke.entities.Entity
:members:
:special-members:

Facts
==============

Expand Down
6 changes: 0 additions & 6 deletions docs/api/groups.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/api/predicates.rst

This file was deleted.

6 changes: 1 addition & 5 deletions docs/api_core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,10 @@ Core
.. toctree::
:maxdepth: 3

api/factors
api/courts
api/opinions
api/decisions
api/holdings
api/factors
api/predicates
api/procedures
api/rules
api/context
api/explanations
api/groups
2 changes: 1 addition & 1 deletion docs/api_io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I/O

io/dump
io/schemas
io/schema_specs
io/api_spec
io/downloads
io/loaders
io/readers
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"legislice": ("https://legislice.readthedocs.io/en/latest/", None),
"nettlesome": ("https://nettlesome.readthedocs.io/en/latest/", None),
"pint": ("https://pint.readthedocs.io/en/stable/", None),
}

Expand Down

0 comments on commit b65ab4f

Please sign in to comment.