readdocs starter

.readthedocs.yaml

@@ -0,0 +1,11 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"

README.md

@@ -1,6 +1,9 @@
-# pycircdb
-
-A command-line tool for identifying and annotating circRNA interactions.
+<h1>
+<picture>
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/BarryDigby/pycircdb/raw/main/assets/pycircdb.png">
+  <img src="https://github.com/BarryDigby/pycircdb/raw/main/assets/pycircdb.png" alt="pycircdb">
+</picture>
+</h1>
 
 ## Installation
 

docs/_static/css/custom.css

@@ -0,0 +1,5 @@
+@import url("theme.css");
+
+.wy-nav-content {
+    max-width: 70;
+ }

docs/conf.py

@@ -0,0 +1,40 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'pycircdb'
+copyright = '2026, Barry Digby'
+author = 'Barry Digby'
+
+release = '0.1'
+version = '0.1.2'
+
+# -- General configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+    #'sphinx.ext.video',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+html_css_files = [
+    'css/custom.css'
+]
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'

docs/requirements.txt

@@ -0,0 +1,4 @@
+Sphinx==5.0.2
+sphinx-argparse
+sphinx-rtd-theme
+Jinja2<3.1