Doc: Add initial Sphinx docs structure

docs/about/index.rst

@@ -0,0 +1,20 @@
+About
+=====
+
+pyosMeta is the package used by pyOpenSci to update contributor metadata and
+peer-review package metadata that powers sections of the pyOpenSci website.
+
+Current CLI entry points include:
+
+* ``parse-history``
+* ``update-contributors``
+* ``update-reviews``
+* ``update-review-teams``
+* ``fetch-rss-feed``
+
+Project resources
+-----------------
+
+* `Repository <https://github.com/pyOpenSci/pyosMeta>`_
+* `Issue tracker <https://github.com/pyOpenSci/pyosMeta/issues>`_
+* `pyOpenSci <https://www.pyopensci.org/>`_

docs/api/index.rst

@@ -0,0 +1,7 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   pyosmeta

docs/api/pyosmeta.rst

@@ -0,0 +1,23 @@
+pyosmeta package
+================
+
+Top-level package
+-----------------
+
+.. automodule:: pyosmeta
+   :members:
+   :show-inheritance:
+
+Core modules
+------------
+
+.. autosummary::
+   :toctree: generated
+
+   pyosmeta.contributors
+   pyosmeta.file_io
+   pyosmeta.github_api
+   pyosmeta.parse_issues
+   pyosmeta.parse_rss
+   pyosmeta.utils_clean
+   pyosmeta.utils_parse

docs/conf.py

@@ -0,0 +1,31 @@
+"""Sphinx configuration for pyosMeta docs."""
+
+from __future__ import annotations
+
+import os
+import sys
+from datetime import datetime
+
+sys.path.insert(0, os.path.abspath("../src"))
+
+project = "pyosMeta"
+author = "pyOpenSci"
+copyright = f"{datetime.now().year}, {author}"
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+]
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+autosummary_generate = True
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": False,
+    "show-inheritance": True,
+}
+
+html_theme = "pydata_sphinx_theme"
+html_title = "pyosMeta documentation"

docs/contributing/index.rst

@@ -0,0 +1,28 @@
+Contributing And Development
+============================
+
+Contributions are welcome.
+
+For now, use these project guides as the canonical references:
+
+* `Contributing guide <https://github.com/pyOpenSci/pyosMeta/blob/main/CONTRIBUTING.md>`_
+* `Development guide <https://github.com/pyOpenSci/pyosMeta/blob/main/development.md>`_
+
+Local setup quick start
+-----------------------
+
+1. Create or activate your Python environment.
+2. Install pyosMeta in editable mode with development dependencies:
+
+   .. code-block:: console
+
+      pip install -e ".[dev]"
+
+3. Run tests:
+
+   .. code-block:: console
+
+      hatch run test:run-coverage
+
+As docs evolve, this section can be expanded with contributor workflows,
+testing guidance, and release procedures from the repository guides.

docs/index.rst

@@ -0,0 +1,15 @@
+pyosMeta Documentation
+======================
+
+pyosMeta provides tooling used by pyOpenSci to maintain contributor and
+peer-review metadata published on pyopensci.org.
+
+This is an initial documentation structure that will be expanded over time.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Documentation
+
+   about/index
+   contributing/index
+   api/index

pyproject.toml

@@ -39,6 +39,11 @@ readme = "README.md"
 license = { text = "MIT" }
 
 [project.optional-dependencies]
+docs = [
+    "pydata-sphinx-theme",
+    "sphinx",
+    "sphinx-autosummary-accessors",
+]
 dev = [
     "black",
     "flake8",