From 4fd07239a69c0c6d29d222493b197b4d22e4e1aa Mon Sep 17 00:00:00 2001 From: Martin Rotter Date: Wed, 27 Sep 2023 08:06:16 +0200 Subject: [PATCH] move documentation to readthedocs, start working on it --- .readthedocs.yaml | 6 +++--- README.md | 1 + {resources/docs => docs/source}/Documentation.md | 0 docs/source/conf.py | 12 ++---------- .../docs => docs/source}/images/about-skins.png | Bin .../docs => docs/source}/images/account-menu.png | Bin {resources/docs => docs/source}/images/accounts.png | Bin {resources/docs => docs/source}/images/adblock.png | Bin .../docs => docs/source}/images/downloader-view.png | Bin .../source}/images/downloader-window.png | Bin .../docs => docs/source}/images/feed-details.png | Bin .../docs => docs/source}/images/filters-dialog.png | Bin {resources/docs => docs/source}/images/gui-dark.png | Bin .../docs => docs/source}/images/gui-dark2.png | Bin .../docs => docs/source}/images/gui-hiding-all.png | Bin .../docs => docs/source}/images/gui-hiding.png | Bin .../source}/images/gui-layout-orientation.png | Bin .../docs => docs/source}/images/label-assign.png | Bin .../docs => docs/source}/images/label-dialog.png | Bin .../docs => docs/source}/images/label-menu.png | Bin {resources/docs => docs/source}/images/notif.png | Bin .../docs => docs/source}/images/query-dialog.png | Bin .../docs => docs/source}/images/rssguard-window.png | Bin {resources/docs => docs/source}/images/rssguard.png | Bin .../docs => docs/source}/images/scrape-post.png | Bin .../source}/images/scrape-source-type.png | Bin docs/source/index.rst | 9 ++------- docs/source/requirements.txt | 1 + 28 files changed, 9 insertions(+), 20 deletions(-) rename {resources/docs => docs/source}/Documentation.md (100%) rename {resources/docs => docs/source}/images/about-skins.png (100%) rename {resources/docs => docs/source}/images/account-menu.png (100%) rename {resources/docs => docs/source}/images/accounts.png (100%) rename {resources/docs => docs/source}/images/adblock.png (100%) rename {resources/docs => docs/source}/images/downloader-view.png (100%) rename {resources/docs => docs/source}/images/downloader-window.png (100%) rename {resources/docs => docs/source}/images/feed-details.png (100%) rename {resources/docs => docs/source}/images/filters-dialog.png (100%) rename {resources/docs => docs/source}/images/gui-dark.png (100%) rename {resources/docs => docs/source}/images/gui-dark2.png (100%) rename {resources/docs => docs/source}/images/gui-hiding-all.png (100%) rename {resources/docs => docs/source}/images/gui-hiding.png (100%) rename {resources/docs => docs/source}/images/gui-layout-orientation.png (100%) rename {resources/docs => docs/source}/images/label-assign.png (100%) rename {resources/docs => docs/source}/images/label-dialog.png (100%) rename {resources/docs => docs/source}/images/label-menu.png (100%) rename {resources/docs => docs/source}/images/notif.png (100%) rename {resources/docs => docs/source}/images/query-dialog.png (100%) rename {resources/docs => docs/source}/images/rssguard-window.png (100%) rename {resources/docs => docs/source}/images/rssguard.png (100%) rename {resources/docs => docs/source}/images/scrape-post.png (100%) rename {resources/docs => docs/source}/images/scrape-source-type.png (100%) create mode 100644 docs/source/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index dc8d4c457..64b18356a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -27,6 +27,6 @@ sphinx: # Optional but recommended, declare the Python requirements required # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt \ No newline at end of file +python: + install: + - requirements: docs/source/requirements.txt \ No newline at end of file diff --git a/README.md b/README.md index 20c03002b..2dfc490c9 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ RSS Guard [![Total downloads](https://img.shields.io/github/downloads/martinrotter/rssguard/total.svg?maxAge=360)](https://somsubhra.github.io/github-release-stats/?username=martinrotter&repository=rssguard&search=0) [![Version](https://img.shields.io/github/release/martinrotter/rssguard.svg?maxAge=360)](https://raw.githubusercontent.com/martinrotter/rssguard/master/resources/text/CHANGELOG) [![Packaging status](https://repology.org/badge/tiny-repos/rssguard.svg)](https://repology.org/project/rssguard/versions) +[![Documentation status](https://readthedocs.org/projects/rssguard/badge/?version=latest)](https://rssguard.readthedocs.io/en/latest/?badge=latest) [![GitHub issues](https://img.shields.io/github/issues/martinrotter/rssguard.svg?maxAge=360)](https://github.com/martinrotter/rssguard/issues) [![License](https://img.shields.io/github/license/martinrotter/rssguard.svg?maxAge=360000)](https://github.com/martinrotter/rssguard/blob/master/LICENSE.md) diff --git a/resources/docs/Documentation.md b/docs/source/Documentation.md similarity index 100% rename from resources/docs/Documentation.md rename to docs/source/Documentation.md diff --git a/docs/source/conf.py b/docs/source/conf.py index e438c212d..ca2ea02ec 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,8 +1,3 @@ -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information @@ -13,15 +8,12 @@ author = 'Martin Rotter' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = [] - +extensions = ["myst_parser"] templates_path = ['_templates'] exclude_patterns = [] - - # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' html_static_path = ['_static'] diff --git a/resources/docs/images/about-skins.png b/docs/source/images/about-skins.png similarity index 100% rename from resources/docs/images/about-skins.png rename to docs/source/images/about-skins.png diff --git a/resources/docs/images/account-menu.png b/docs/source/images/account-menu.png similarity index 100% rename from resources/docs/images/account-menu.png rename to docs/source/images/account-menu.png diff --git a/resources/docs/images/accounts.png b/docs/source/images/accounts.png similarity index 100% rename from resources/docs/images/accounts.png rename to docs/source/images/accounts.png diff --git a/resources/docs/images/adblock.png b/docs/source/images/adblock.png similarity index 100% rename from resources/docs/images/adblock.png rename to docs/source/images/adblock.png diff --git a/resources/docs/images/downloader-view.png b/docs/source/images/downloader-view.png similarity index 100% rename from resources/docs/images/downloader-view.png rename to docs/source/images/downloader-view.png diff --git a/resources/docs/images/downloader-window.png b/docs/source/images/downloader-window.png similarity index 100% rename from resources/docs/images/downloader-window.png rename to docs/source/images/downloader-window.png diff --git a/resources/docs/images/feed-details.png b/docs/source/images/feed-details.png similarity index 100% rename from resources/docs/images/feed-details.png rename to docs/source/images/feed-details.png diff --git a/resources/docs/images/filters-dialog.png b/docs/source/images/filters-dialog.png similarity index 100% rename from resources/docs/images/filters-dialog.png rename to docs/source/images/filters-dialog.png diff --git a/resources/docs/images/gui-dark.png b/docs/source/images/gui-dark.png similarity index 100% rename from resources/docs/images/gui-dark.png rename to docs/source/images/gui-dark.png diff --git a/resources/docs/images/gui-dark2.png b/docs/source/images/gui-dark2.png similarity index 100% rename from resources/docs/images/gui-dark2.png rename to docs/source/images/gui-dark2.png diff --git a/resources/docs/images/gui-hiding-all.png b/docs/source/images/gui-hiding-all.png similarity index 100% rename from resources/docs/images/gui-hiding-all.png rename to docs/source/images/gui-hiding-all.png diff --git a/resources/docs/images/gui-hiding.png b/docs/source/images/gui-hiding.png similarity index 100% rename from resources/docs/images/gui-hiding.png rename to docs/source/images/gui-hiding.png diff --git a/resources/docs/images/gui-layout-orientation.png b/docs/source/images/gui-layout-orientation.png similarity index 100% rename from resources/docs/images/gui-layout-orientation.png rename to docs/source/images/gui-layout-orientation.png diff --git a/resources/docs/images/label-assign.png b/docs/source/images/label-assign.png similarity index 100% rename from resources/docs/images/label-assign.png rename to docs/source/images/label-assign.png diff --git a/resources/docs/images/label-dialog.png b/docs/source/images/label-dialog.png similarity index 100% rename from resources/docs/images/label-dialog.png rename to docs/source/images/label-dialog.png diff --git a/resources/docs/images/label-menu.png b/docs/source/images/label-menu.png similarity index 100% rename from resources/docs/images/label-menu.png rename to docs/source/images/label-menu.png diff --git a/resources/docs/images/notif.png b/docs/source/images/notif.png similarity index 100% rename from resources/docs/images/notif.png rename to docs/source/images/notif.png diff --git a/resources/docs/images/query-dialog.png b/docs/source/images/query-dialog.png similarity index 100% rename from resources/docs/images/query-dialog.png rename to docs/source/images/query-dialog.png diff --git a/resources/docs/images/rssguard-window.png b/docs/source/images/rssguard-window.png similarity index 100% rename from resources/docs/images/rssguard-window.png rename to docs/source/images/rssguard-window.png diff --git a/resources/docs/images/rssguard.png b/docs/source/images/rssguard.png similarity index 100% rename from resources/docs/images/rssguard.png rename to docs/source/images/rssguard.png diff --git a/resources/docs/images/scrape-post.png b/docs/source/images/scrape-post.png similarity index 100% rename from resources/docs/images/scrape-post.png rename to docs/source/images/scrape-post.png diff --git a/resources/docs/images/scrape-source-type.png b/docs/source/images/scrape-source-type.png similarity index 100% rename from resources/docs/images/scrape-source-type.png rename to docs/source/images/scrape-source-type.png diff --git a/docs/source/index.rst b/docs/source/index.rst index 4b3921ec6..a7fee4bbe 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,16 +1,11 @@ -.. RSS Guard documentation master file, created by - sphinx-quickstart on Wed Sep 27 06:30:34 2023. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to RSS Guard's documentation! +RSS Guards documentation! ===================================== .. toctree:: :maxdepth: 2 :caption: Contents: - + Documentation Indices and tables ================== diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt new file mode 100644 index 000000000..4170c03ef --- /dev/null +++ b/docs/source/requirements.txt @@ -0,0 +1 @@ +sphinx-rtd-theme \ No newline at end of file