From 63f950e818a3a81d3db3561b3ba8e8acc2600dce Mon Sep 17 00:00:00 2001 From: Barry digby Date: Tue, 16 Jun 2026 15:06:20 +0100 Subject: [PATCH 1/2] add logo --- README.md | 9 ++++++--- foo.tsv | 3 --- 2 files changed, 6 insertions(+), 6 deletions(-) delete mode 100644 foo.tsv diff --git a/README.md b/README.md index b31743d..81f22a7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -# pycircdb - -A command-line tool for identifying and annotating circRNA interactions. +

+ + + pycircdb + +

## Installation diff --git a/foo.tsv b/foo.tsv deleted file mode 100644 index 918dd1d..0000000 --- a/foo.tsv +++ /dev/null @@ -1,3 +0,0 @@ -hey you there -I am line -three lol From 410c5fa7a9233235c155948505146d12bdd4a879 Mon Sep 17 00:00:00 2001 From: Barry digby Date: Tue, 16 Jun 2026 15:36:15 +0100 Subject: [PATCH 2/2] add readme docs --- .readthedocs.yaml | 11 ++++++++++ docs/_static/css/custom.css | 5 +++++ docs/conf.py | 40 +++++++++++++++++++++++++++++++++++++ docs/index.rst | 0 docs/requirements.txt | 4 ++++ 5 files changed, 60 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/_static/css/custom.css create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..c464de7 --- /dev/null +++ b/.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" diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css new file mode 100644 index 0000000..8ffeee5 --- /dev/null +++ b/docs/_static/css/custom.css @@ -0,0 +1,5 @@ +@import url("theme.css"); + +.wy-nav-content { + max-width: 70; + } diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..c8115d5 --- /dev/null +++ b/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' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..e69de29 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..12cccff --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +Sphinx==5.0.2 +sphinx-argparse +sphinx-rtd-theme +Jinja2<3.1