release v0.1

.readthedocs.yml

@@ -0,0 +1,15 @@
+# Config file for Sphinx build on ReadTheDocs:
+# https://docs.readthedocs.io/en/stable/config-file/
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+python:
+   install:
+      - method: pip
+        path: .
+      - requirements: docs/requirements.txt

README.md

@@ -1,24 +1,31 @@
 arroba [![Circle CI](https://circleci.com/gh/snarfed/arroba.svg?style=svg)](https://circleci.com/gh/snarfed/arroba) [![Coverage Status](https://coveralls.io/repos/github/snarfed/arroba/badge.svg?branch=main)](https://coveralls.io/github/snarfed/arroba?branch=master)
 ===
 
-Python implementation of [Bluesky](https://blueskyweb.xyz/)'s low level [AT Protocol](https://atproto.com/), including [data repository](https://atproto.com/guides/data-repos), [Merkle search tree](https://atproto.com/guides/data-repos), and [`com.atproto.sync` XRPC methods](https://atproto.com/lexicons/com-atproto-sync).
+Python implementation of [Bluesky](https://blueskyweb.xyz/)'s low level [AT Protocol](https://atproto.com/), including [data repository](https://atproto.com/guides/data-repos), [Merkle search tree](https://atproto.com/guides/data-repos), and [com.atproto.sync XRPC methods](https://atproto.com/lexicons/com-atproto-sync).
 
-_Arroba_ is the Spanish word for the [`@` character, ie "at sign."](https://en.wikipedia.org/wiki/At_sign)
+_Arroba_ is the Spanish word for the [@ character](https://en.wikipedia.org/wiki/At_sign) ("at sign").
 
 Install from [PyPI](https://pypi.org/project/arroba/) with `pip install arroba`.
 
 License: This project is placed into the public domain.
 
 * [Usage](#usage)
-* [Release instructions](#release-instructions)
 * [Changelog](#changelog)
+* [Release instructions](#release-instructions)
 
 
 ## Usage
 
 TODO
 
 
+## Changelog
+
+### 0.1 - 2023-04-30
+
+Initial release! Still very in progress. MST, Walker, and Diff classes are mostly complete and working. Repo, commits, and sync XRPC methods are still in progress.
+
+
 Release instructions
 ---
 Here's how to package, test, and ship a new release.
@@ -72,10 +79,3 @@ Here's how to package, test, and ship a new release.
     ```
 1. [Wait for the docs to build on Read the Docs](https://readthedocs.org/projects/arroba/builds/), then check that they look ok.
 1. On the [Versions page](https://readthedocs.org/projects/arroba/versions/), check that the new version is active, If it's not, activate it in the _Activate a Version_ section.
-
-
-## Changelog
-
-### 0.1 - unreleased
-
-Initial release! Still very in progress.

docs/_static/custom.css

@@ -0,0 +1,27 @@
+/* Duplicated in oauth-dropins, granary, bridgy! */
+.icon-home {
+  font-size: larger !important;
+}
+
+.wy-nav-side, .wy-side-nav-search > div.version {
+  color: #fcfcfc;
+}
+
+.rst-content code, .rst-content tt, code {
+  border: none;
+  padding: 0;
+}
+
+/* The first link in the reference doc TOC is the page title/header. Hide that.  */
+#contents #id1 {
+  display: none;
+}
+
+/* The first link in the sidebar TOC is the page title/header. Hide that.  */
+.local-toc ul:nth-child(3) li:first-child {
+  display: none;
+}
+
+.logo {
+  width: 5em !important;
+}

docs/_templates/breadcrumbs.html

@@ -0,0 +1 @@
+<hr/>

docs/_templates/layout.html

@@ -0,0 +1,24 @@
+{% extends "!layout.html" %}
+
+{%- block navigation %}
+
+
+<div style="width: 300px; text-align: center; font-size: larger">
+
+<a href="https://atproto.com/specs/atp">AT Protocol</a> in Python</p>
+
+</div>
+
+<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Navigation menu') }}">
+<div class="local-toc">
+  <ul>
+    <li><a href="{{ pathto('index') }}">Getting started</a></li>
+    <li><a href="{{ pathto('source/arroba') }}">Reference documentation</a></li>
+  </ul>
+  <hr style="margin: 1em">
+  {{ toc }}
+</div>
+</div>
+
+
+{%- endblock %}

docs/build.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+#
+# Preprocesses docs and runs Sphinx (apidoc and build) to build the HTML docs.
+#
+# Requires:
+#  brew install pandoc
+#  pip install sphinx sphinx_rtd_theme  (in virtualenv)
+set -e
+
+absfile=`readlink -f $0`
+cd `dirname $absfile`
+
+# generates the module index file docs/source/arroba.rst, only used to
+# bootstrap. we edit by hand since then so don't run any more or it will
+# overwrite it.
+# sphinx-apidoc -f -o source ../arroba ../arroba/tests
+
+rm -f index.rst
+cat > index.rst <<EOF
+arroba
+------
+
+EOF
+
+tail -n +4 ../README.md \
+  | pandoc --from=markdown --to=rst \
+  | sed -E 's/```/`/; s/`` </ </' \
+  >> index.rst
+
+source ../local/bin/activate
+
+# Run sphinx in the virtualenv's python interpreter so it can import packages
+# installed in the virtualenv.
+python3 `which sphinx-build` -b html . _build/html