toctrees

poetry.lock

@@ -213,6 +213,20 @@ MarkupSafe = ">=2.0"
 [package.extras]
 i18n = ["Babel (>=2.7)"]
 
+[[package]]
+name = "latexcodec"
+version = "2.0.1"
+description = "A lexer and codec to work with LaTeX code in Python."
+optional = false
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+files = [
+    {file = "latexcodec-2.0.1-py2.py3-none-any.whl", hash = "sha256:c277a193638dc7683c4c30f6684e3db728a06efb0dc9cf346db8bd0aa6c5d271"},
+    {file = "latexcodec-2.0.1.tar.gz", hash = "sha256:2aa2551c373261cefe2ad3a8953a6d6533e68238d180eb4bb91d7964adb3fe9a"},
+]
+
+[package.dependencies]
+six = ">=1.4.1"
+
 [[package]]
 name = "livereload"
 version = "2.6.3"
@@ -378,6 +392,40 @@ files = [
     {file = "packaging-23.1.tar.gz", hash = "sha256:a392980d2b6cffa644431898be54b0045151319d1e7ec34f0cfed48767dd334f"},
 ]
 
+[[package]]
+name = "pybtex"
+version = "0.24.0"
+description = "A BibTeX-compatible bibliography processor in Python"
+optional = false
+python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*"
+files = [
+    {file = "pybtex-0.24.0-py2.py3-none-any.whl", hash = "sha256:e1e0c8c69998452fea90e9179aa2a98ab103f3eed894405b7264e517cc2fcc0f"},
+    {file = "pybtex-0.24.0.tar.gz", hash = "sha256:818eae35b61733e5c007c3fcd2cfb75ed1bc8b4173c1f70b56cc4c0802d34755"},
+]
+
+[package.dependencies]
+latexcodec = ">=1.0.4"
+PyYAML = ">=3.01"
+six = "*"
+
+[package.extras]
+test = ["pytest"]
+
+[[package]]
+name = "pybtex-docutils"
+version = "1.0.2"
+description = "A docutils backend for pybtex."
+optional = false
+python-versions = ">=3.6"
+files = [
+    {file = "pybtex-docutils-1.0.2.tar.gz", hash = "sha256:43aa353b6d498fd5ac30f0073a98e332d061d34fe619d3d50d1761f8fd4aa016"},
+    {file = "pybtex_docutils-1.0.2-py3-none-any.whl", hash = "sha256:6f9e3c25a37bcaac8c4f69513272706ec6253bb708a93d8b4b173f43915ba239"},
+]
+
+[package.dependencies]
+docutils = ">=0.8"
+pybtex = ">=0.16"
+
 [[package]]
 name = "pygments"
 version = "2.15.1"
@@ -580,6 +628,23 @@ files = [
 lint = ["docutils-stubs", "flake8", "mypy"]
 test = ["pytest"]
 
+[[package]]
+name = "sphinxcontrib-bibtex"
+version = "2.5.0"
+description = "Sphinx extension for BibTeX style citations."
+optional = false
+python-versions = ">=3.6"
+files = [
+    {file = "sphinxcontrib-bibtex-2.5.0.tar.gz", hash = "sha256:71b42e5db0e2e284f243875326bf9936aa9a763282277d75048826fef5b00eaa"},
+    {file = "sphinxcontrib_bibtex-2.5.0-py3-none-any.whl", hash = "sha256:748f726eaca6efff7731012103417ef130ecdcc09501b4d0c54283bf5f059f76"},
+]
+
+[package.dependencies]
+docutils = ">=0.8"
+pybtex = ">=0.24"
+pybtex-docutils = ">=1.0.0"
+Sphinx = ">=2.1"
+
 [[package]]
 name = "sphinxcontrib-devhelp"
 version = "1.0.2"
@@ -705,4 +770,4 @@ zstd = ["zstandard (>=0.18.0)"]
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.11"
-content-hash = "da478630e3da73e9f7b95bc23c59d4a02330d20fd9ac38ffb137098aa783d314"
+content-hash = "fd560ec0effde224dbc8327246e38034fb217203db89974874f948dbc41d38ac"

pyproject.toml

@@ -13,6 +13,7 @@ sphinx = "^6.2.1"
 myst-parser = "^1.0.0"
 furo = "^2023.5.20"
 sphinxcontrib-mermaid = "^0.9.2"
+sphinxcontrib-bibtex = "^2.5.0"
 
 
 [tool.poetry.group.dev.dependencies]

src/README.md

@@ -1,6 +0,0 @@
-# Introduction
-
-All of this is very work in progress :) plz do not rely on any of the descriptions or statements here, as they are all effectively provisional.
-
-This site describes the implementation of the p2p linked data protocol in {{#cite saundersDecentralizedInfrastructureNeuro2022 }}
-

src/SUMMARY.md

@@ -1,32 +0,0 @@
-# Summary
-
-[Introduction](README.md)
-
-
-- [Overview](./overview.md)
-- [Comparison](./comparison.md)
-- [P2P Concepts](./p2p_concepts.md)
-- [Out of Scope](./out_of_scope.md)
-
-# p2p-ld Protocol
-
-- [Definitions](./definitions.md)
-- [Protocol](./protocol.md)
-- [Identity](./identity.md)
-- [Discovery](./discovery.md)
-- [Data Structures](./data_structures.md)
-- [Vocabulary](./vocabulary.md)
-- [Querying](./querying.md)
-- [Encryption](./encryption.md)
-- [Federation](./federation.md)
-- [Backwards Compatibility](./backwards_compatibility.md)
-- [Evolvability](./evolvability.md)
-
-# Ecosystem
-
-- [Triplets]()
-- [Translation]()
-
----
-
-[Sketchpad](./sketchpad.md)

src/conf.py

@@ -18,6 +18,7 @@ extensions = [
     'sphinx.ext.napoleon',
     'sphinx.ext.autodoc',
     'sphinxcontrib.mermaid',
+    'sphinxcontrib.bibtex',
     'myst_parser'
 ]
 
@@ -50,4 +51,8 @@ napoleon_use_param = True
 napoleon_use_rtype = True
 napoleon_preprocess_types = False
 napoleon_type_aliases = None
-napoleon_attr_annotations = True
+napoleon_attr_annotations = True
+
+# bibtex
+bibtex_bibfiles = ['p2p_ld_docs.bib']
+bibtex_reference_style = 'author_year'

src/identity.md

@@ -6,7 +6,7 @@ How is an individual peer identified?
 - Web of trust/shared identity
 - External verification/discovery via DNS and other out of band means.
 
-## Instances
+## {index}`Instances`
 
 A given identity can have 0 or many instances - a manifestation of the peer within a particular server and runtime. 
 
@@ -31,4 +31,5 @@ An identity has a specific field indicating whether it is "active" or "retired,"
 
 Any peer can operate as a "Pub" (in the parlance of SSB) or a bootstrapping node, where a dereferenceable network location (eg. DNS) can be resolved to a
 
-A given identity can have 0 or many static inbound references that can resolve a network
+A given identity can have 0 or many static inbound references that can resolve a network
+

src/index.md

@@ -0,0 +1,57 @@
+# p2p-ld
+
+All of this is very work in progress :) plz do not rely on any of the descriptions or statements here, as they are all effectively provisional.
+
+This site describes the implementation of the p2p linked data protocol in {cite}`saundersDecentralizedInfrastructureNeuro2022`
+
+```{toctree}
+:caption: Introduction
+
+overview
+comparison
+p2p_concepts
+out_of_scope
+```
+
+```{toctree}
+:caption: Protocol
+
+definitions
+protocol
+identity
+discovery
+data_structures
+vocabulary
+querying
+encryption
+federation
+backwards_compatibility
+evolvability
+```
+
+```{toctree}
+:caption: Ecosystem
+
+triplets
+translation
+```
+
+```{toctree}
+:caption: Drafting
+
+sketchpad
+```
+
+```{toctree}
+:caption: Meta
+
+genindex
+references
+```
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

src/index.rst

@@ -1,20 +0,0 @@
-.. p2p-ld documentation master file, created by
-   sphinx-quickstart on Tue Jun  6 17:47:24 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to p2p-ld's documentation!
-==================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

src/p2p_ld_docs.bib

@@ -2,6 +2,9 @@
   title = {Decentralized Infrastructure for (Neuro)Science},
   author = {Saunders, Jonny L.},
   date = {2022-08-31},
+  year = {2022},
+  month = {08},
+  day = {31},
   eprint = {2209.07493},
   eprinttype = {arxiv},
   eprintclass = {cs},

src/protocol.md

@@ -14,4 +14,4 @@
 
 Every link has an implicit backlink that can be accepted/denied by the owner of the referenced object. 
 
-If a link is proposed from a blocked identifier, the proposed link is automatically dropped
+If a link is proposed from a blocked identifier, the proposed link is automatically dropped 

src/references.md

@@ -1 +1,5 @@
 # References
+
+```{bibliography}
+
+```

src/translation.md

@@ -0,0 +1,3 @@
+# Translation
+
+A toolkit for writing translations between formats and schemas!

src/triplets.md

@@ -0,0 +1,3 @@
+# Triplets
+
+A package for creating and manipulating triplet-like data in several formats :)