From af54c421803ea133f98d08c03a7e91fa017c962f Mon Sep 17 00:00:00 2001 From: KaraMelih Date: Tue, 13 Aug 2024 14:29:34 -0500 Subject: [PATCH] clean up --- docs/_static/css/my_theme.css | 2 +- docs/_templates/layout.html | 2 +- docs/api/api.rst | 12 ------------ docs/api/message_schema.rst | 7 ------- docs/api/snews_pt_utils.rst | 7 ------- docs/api/snews_pub.rst | 7 ------- docs/api/snews_sub.rst | 7 ------- docs/conf.py | 2 +- docs/user/faq.md | 6 +++--- 9 files changed, 6 insertions(+), 46 deletions(-) delete mode 100644 docs/api/api.rst delete mode 100644 docs/api/message_schema.rst delete mode 100644 docs/api/snews_pt_utils.rst delete mode 100644 docs/api/snews_pub.rst delete mode 100644 docs/api/snews_sub.rst diff --git a/docs/_static/css/my_theme.css b/docs/_static/css/my_theme.css index 4e354c4..e9dff95 100644 --- a/docs/_static/css/my_theme.css +++ b/docs/_static/css/my_theme.css @@ -20,7 +20,7 @@ .wy-nav-top { background-color: #3B556F; #background-color: #fcfcfc; - background-image: url('../logo.png'); + background-image: url('../images/custom_logo.png'); background-repeat: no-repeat; background-position: bottom; padding: 0; diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index 0b9fcba..d00e6fb 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -1,2 +1,2 @@ -{%- set logo = "logo.png" %} +{%- set logo = "../_static/images/custom_logo.png" %} {% extends "!layout.html" %} diff --git a/docs/api/api.rst b/docs/api/api.rst deleted file mode 100644 index 2c2beec..0000000 --- a/docs/api/api.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _api: - -snews API -################# - -.. toctree:: - :maxdepth: 2 - - message_schema - snews_pt_utils - snews_pub - snews_sub diff --git a/docs/api/message_schema.rst b/docs/api/message_schema.rst deleted file mode 100644 index 1d04470..0000000 --- a/docs/api/message_schema.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _message_schema: - -snews_pt.message_schema -##################### - -.. automodule:: snews_pt.message_schema - :members: diff --git a/docs/api/snews_pt_utils.rst b/docs/api/snews_pt_utils.rst deleted file mode 100644 index 4aa60c9..0000000 --- a/docs/api/snews_pt_utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _snews_pt_utils: - -snews_pt.generate -##################### - -.. automodule:: snews_pt.snews_pt_utils - :members: diff --git a/docs/api/snews_pub.rst b/docs/api/snews_pub.rst deleted file mode 100644 index be82ce0..0000000 --- a/docs/api/snews_pub.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _snews_pub: - -snews_pt.snews_pub -################## - -.. automodule:: snews_pt.snews_pub - :members: diff --git a/docs/api/snews_sub.rst b/docs/api/snews_sub.rst deleted file mode 100644 index 5422a86..0000000 --- a/docs/api/snews_sub.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _snews_sub: - -snews_pt.snews_sub -##################### - -.. automodule:: snews_pt.snews_sub - :members: diff --git a/docs/conf.py b/docs/conf.py index 2e8a87b..9826f74 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -114,7 +114,7 @@ def setup(app): html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] -html_logo = "./custom_logo.png" +html_logo = "./_static/images/custom_logo.png" html_theme_options = { 'logo_only': True, 'display_version': True, diff --git a/docs/user/faq.md b/docs/user/faq.md index 1e335a1..48d9d95 100644 --- a/docs/user/faq.md +++ b/docs/user/faq.md @@ -9,9 +9,9 @@ If you have a question that is not answered here, please feel free to open an is Easiest is to follow the instructions in the [Quick Start](https://snews-publishing-tools.readthedocs.io/en/latest/user/quickstart.html) guide.
Once created you can add your credentials from the terminal - ```bash - hop auth add - ``` +```bash +hop auth add +``` which will prompt you to enter your username and password. Then your credentials will be stored on your local machine (`hop auth locate`). You do not need to do anything else, as snews_pt will automatically use these credentials when you publish or subscribe to the SNEWS servers.