Merge pull request #2 from p2p-ld/docs

docs :)

Author: sneakers-the-rat

.github/workflows/docs-preview.yml

@@ -0,0 +1,16 @@
+name: readthedocs PR Preview links
+on:
+  pull_request_target:
+    types:
+      - opened
+
+permissions:
+  pull-requests: write
+
+jobs:
+  documentation-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "torrent-models"

.gitignore

@@ -176,4 +176,7 @@ cython_debug/
 prof
 .codspeed
 __tmp__
-*giant*.torrent
+*giant*.torrent
+
+docs/new-tentacoli.torrent
+docs/my_files/*

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+build:
+ os: ubuntu-22.04
+ tools:
+   python: "3.13"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

docs/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     = .
+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)

docs/_static/css/notebooks.css

@@ -0,0 +1,31 @@
+div.cell.tag_hide-cell details.above-input > summary,
+div.cell.tag_hide-input details.above-input > summary,
+div.cell.tag_hide-output details.below-input > summary{
+    background-color: var(--color-admonition-title-background--admonition-todo);
+    color: var(--color-content-foreground);
+    border: unset;
+    border-left: 2px solid var(--mystnb-source-margin-color);
+    opacity: unset;
+    padding: 0.25em 0 0.25em 1em;
+}
+
+div.cell.tag_hide-cell details.above-input > summary > span,
+div.cell.tag_hide-input details.above-input > summary > span,
+div.cell.tag_hide-output details.below-input > summary > span
+{
+    opacity: unset;
+}
+
+div.cell details.above-input div.cell_input {
+    border: unset;
+    background-color: unset;
+    border-left: 2px solid var(--mystnb-source-margin-color);
+}
+
+div.cell details.above-input div.cell_input div.highlight {
+    background: var(--color-admonition-background);
+}
+
+.output.text_html pre {
+    font-size: 0.8em;
+}

docs/api/create.md

@@ -0,0 +1,7 @@
+# `create`
+
+```{eval-rst}
+.. automodule:: torrent_models.create
+    :members:
+    :undoc-members:
+``` 

docs/api/hashing.md

@@ -0,0 +1,33 @@
+# `hashing`
+
+## Base
+
+```{eval-rst}
+.. automodule:: torrent_models.hashing.base
+    :members:
+    :undoc-members:
+``` 
+
+## V1
+
+```{eval-rst}
+.. automodule:: torrent_models.hashing.v1
+    :members:
+    :undoc-members:
+``` 
+
+## V2
+
+```{eval-rst}
+.. automodule:: torrent_models.hashing.v2
+    :members:
+    :undoc-members:
+``` 
+
+## Hybrid
+
+```{eval-rst}
+.. automodule:: torrent_models.hashing.hybrid
+    :members:
+    :undoc-members:
+``` 

docs/api/info.md

@@ -0,0 +1,17 @@
+# `info`
+
+Infodict models!!
+
+Each of the flavors of infodict have a version intended to validate
+and represent already-created torrent files,
+and a `Create` version used while creating torrents!
+
+```{inheritance-diagram} torrent_models.info
+:top-classes: torrent_models.info.InfoDictRoot 
+```
+
+```{eval-rst}
+.. automodule:: torrent_models.info
+    :members:
+    :undoc-members:
+```

docs/api/libtorrent.md

@@ -0,0 +1,11 @@
+# `libtorrent`
+
+Mostly for testing, utilities to use libtorrent to create torrents.
+
+Must install with `torrent-models[libtorrent]`
+
+```{eval-rst}
+.. automodule:: torrent_models.libtorrent
+    :members:
+    :undoc-members:
+``` 

docs/api/torrent.md

@@ -0,0 +1,7 @@
+# `torrent`
+
+```{eval-rst}
+.. automodule:: torrent_models.torrent
+    :members:
+    :undoc-members:
+```