commit 5a22e149bc23a3f7aa53d4564df4a6bf195c1110
parent 8ee520dd54c4b187832593dd87d4f445a0328269
Author: arjoonn <arjoonn@noreply.localhost>
Date: Fri, 24 Mar 2023 10:15:55 +0000
Use RTFD theme for docs (!75)
Reviewed-on: https://gitea.midpathsoftware.com/midpath/jaypore_ci/pulls/75
╔ 🔴 : JayporeCI [sha 4f0d7a14d4]
┏━ build-and-test
┃
┃ 🟢 : JciEnv [d8f0d9d9] 0:11
┃ 🟢 : Jci [b0413e9a] 0:16 ❮-- ['JciEnv']
┃ 🟢 : black [23c5126b] 0: 0 ❮-- ['JciEnv']
┃ 🟢 : install-test [f2218350] 0: 0 ❮-- ['JciEnv']
┃ 🟢 : pylint [2f676f3a] 0: 8 ❮-- ['JciEnv']
┃ 🟢 : pytest [11330c9f] 0:24 Cov: 89% ❮-- ['JciEnv']
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
┏━ Publish
┃
┃ 🟢 : DockerHubJci [7f476cef] 0:55
┃ 🟢 : DockerHubJcienv [a7f3d8ad] 1: 1
┃ 🟢 : PublishDocs [8cdf8039] 0:41
┃ 🔴 : PublishPypi [cc6315f0] 0: 4 v0.2.29
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Diffstat:
5 files changed, 69 insertions(+), 29 deletions(-)
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -13,7 +13,11 @@ author = "Arjoonn Sharma"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary"]
+extensions = [
+ "sphinx.ext.autodoc",
+ "sphinx.ext.autosummary",
+ "sphinx_rtd_theme",
+]
templates_path = ["_templates"]
exclude_patterns = []
@@ -32,15 +36,17 @@ html_sidebars = {
]
}
html_favicon = "_static/logo.ico"
-html_theme = "alabaster"
+# html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
html_theme_options = {
- "logo_name": "Jaypore CI",
- "logo": "logo.png",
- "touch_icon": "logo.png",
- "github_user": "theSage21",
- "github_repo": "jaypore_ci",
- "github_banner": True,
- "github_button": True,
- "description": "Simple, flexible, powerful; Like the city of Jaypore.",
+ "display_version": True,
+ "prev_next_buttons_location": "bottom",
+ # Toc options
+ "collapse_navigation": True,
+ "sticky_navigation": True,
+ "navigation_depth": 4,
+ # "includehidden": True,
+ # "titles_only": False,
}
+master_doc = "contents"
diff --git a/docs/source/contents.rst b/docs/source/contents.rst
@@ -0,0 +1,3 @@
+.. toctree::
+
+ index
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,8 +3,10 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
+TLDR
+====
+
|logo|
-======
- **Jaypore CI** is a *small*, *very flexible*, and *powerful* system for automation within software projects.
- Latest version: |package_version|
@@ -13,9 +15,7 @@
- `Docker Hub <https://hub.docker.com/r/arjoonn/jci>`_
- `Github Mirror <https://github.com/theSage21/jaypore_ci>`_
-
-TLDR
-----
+------------
- Configure pipelines in Python
- Jobs are run using `Docker <https://www.docker.com/>`_; on your laptop and on cloud IF needed.
@@ -23,11 +23,6 @@ TLDR
PR, Github PR, or write your own class and send it where you want.
-Contents
---------
-
-.. contents::
-
Getting Started
===============
@@ -224,7 +219,7 @@ Run on cloud/remote runners
- Make sure you have ssh access to remote machine and the user you are logging in as can run docker commands.
- Add to your local `~.ssh/config` an entry for your remote machine. Something like:
- .. code-block:: config
+ .. code-block:: text
Host my.aws.machine
HostName some.aws.machine
@@ -384,6 +379,6 @@ Reference
:alt: Jaypore CI
:align: middle
-
Changelog
=========
+
diff --git a/poetry.lock b/poetry.lock
@@ -329,14 +329,14 @@ ssh = ["paramiko (>=2.4.3)"]
[[package]]
name = "docutils"
-version = "0.19"
+version = "0.18.1"
description = "Docutils -- Python Documentation Utilities"
category = "dev"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
files = [
- {file = "docutils-0.19-py3-none-any.whl", hash = "sha256:5e1de4d849fee02c63b040a4a3fd567f4ab104defd8a5511fbbc24a8a017efbc"},
- {file = "docutils-0.19.tar.gz", hash = "sha256:33995a6753c30b7f577febfc2c50411fec6aac7f7ffeb7c4cfe5991072dcf9e6"},
+ {file = "docutils-0.18.1-py2.py3-none-any.whl", hash = "sha256:23010f129180089fbcd3bc08cfefccb3b890b0050e1ca00c867036e9d161b98c"},
+ {file = "docutils-0.18.1.tar.gz", hash = "sha256:679987caf361a7539d76e584cbeddc311e3aee937877c87346f31debc63e9d06"},
]
[[package]]
@@ -766,14 +766,14 @@ plugins = ["importlib-metadata"]
[[package]]
name = "pylint"
-version = "2.17.0"
+version = "2.17.1"
description = "python code static checker"
category = "dev"
optional = false
python-versions = ">=3.7.2"
files = [
- {file = "pylint-2.17.0-py3-none-any.whl", hash = "sha256:e097d8325f8c88e14ad12844e3fe2d963d3de871ea9a8f8ad25ab1c109889ddc"},
- {file = "pylint-2.17.0.tar.gz", hash = "sha256:1460829b6397cb5eb0cdb0b4fc4b556348e515cdca32115f74a1eb7c20b896b4"},
+ {file = "pylint-2.17.1-py3-none-any.whl", hash = "sha256:8660a54e3f696243d644fca98f79013a959c03f979992c1ab59c24d3f4ec2700"},
+ {file = "pylint-2.17.1.tar.gz", hash = "sha256:d4d009b0116e16845533bc2163493d6681846ac725eab8ca8014afb520178ddd"},
]
[package.dependencies]
@@ -1016,6 +1016,26 @@ lint = ["docutils-stubs", "flake8 (>=3.5.0)", "flake8-bugbear", "flake8-comprehe
test = ["cython", "html5lib", "pytest (>=4.6)", "typed_ast"]
[[package]]
+name = "sphinx-rtd-theme"
+version = "1.2.0"
+description = "Read the Docs theme for Sphinx"
+category = "dev"
+optional = false
+python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,>=2.7"
+files = [
+ {file = "sphinx_rtd_theme-1.2.0-py2.py3-none-any.whl", hash = "sha256:f823f7e71890abe0ac6aaa6013361ea2696fc8d3e1fa798f463e82bdb77eeff2"},
+ {file = "sphinx_rtd_theme-1.2.0.tar.gz", hash = "sha256:a0d8bd1a2ed52e0b338cbe19c4b2eef3c5e7a048769753dac6a9f059c7b641b8"},
+]
+
+[package.dependencies]
+docutils = "<0.19"
+sphinx = ">=1.6,<7"
+sphinxcontrib-jquery = {version = ">=2.0.0,<3.0.0 || >3.0.0", markers = "python_version > \"3\""}
+
+[package.extras]
+dev = ["bump2version", "sphinxcontrib-httpdomain", "transifex-client", "wheel"]
+
+[[package]]
name = "sphinxcontrib-applehelp"
version = "1.0.4"
description = "sphinxcontrib-applehelp is a Sphinx extension which outputs Apple help books"
@@ -1064,6 +1084,21 @@ lint = ["docutils-stubs", "flake8", "mypy"]
test = ["html5lib", "pytest"]
[[package]]
+name = "sphinxcontrib-jquery"
+version = "4.1"
+description = "Extension to include jQuery on newer Sphinx releases"
+category = "dev"
+optional = false
+python-versions = ">=2.7"
+files = [
+ {file = "sphinxcontrib-jquery-4.1.tar.gz", hash = "sha256:1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a"},
+ {file = "sphinxcontrib_jquery-4.1-py2.py3-none-any.whl", hash = "sha256:f936030d7d0147dd026a4f2b5a57343d233f1fc7b363f68b3d4f1cb0993878ae"},
+]
+
+[package.dependencies]
+Sphinx = ">=1.8"
+
+[[package]]
name = "sphinxcontrib-jsmath"
version = "1.0.1"
description = "A sphinx extension which renders display math in HTML via JavaScript"
@@ -1323,4 +1358,4 @@ testing = ["big-O", "flake8 (<5)", "jaraco.functools", "jaraco.itertools", "more
[metadata]
lock-version = "2.0"
python-versions = "^3.8"
-content-hash = "f2c5bfcbd266eceaa212a4506e9b9345b1eb02fac8aec9ad72d3ed638532da71"
+content-hash = "524db2ef19c7ef454826113dd7c111e43592aa1c288db731a4c2a7951ecf7ac3"
diff --git a/pyproject.toml b/pyproject.toml
@@ -24,6 +24,7 @@ rich = "^13.2.0"
coverage = "^7.0.5"
pytest-profiling = "^1.7.0"
hypothesis = "^6.68.2"
+sphinx-rtd-theme = "^1.2.0"
[build-system]
requires = ["poetry-core>=1.0.0"]
