Skip to content
This repository has been archived by the owner on Jul 16, 2023. It is now read-only.

Commit

Permalink
Added tabbed interfaces to docs/homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
rjdbcm committed Aug 22, 2021
1 parent 54121d2 commit 01c8e23
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 27 deletions.
2 changes: 2 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ pytest-cov = "*"
pytest-sugar = "*"
sphinx = "*"
sphinx_rtd_theme = "*"
sphinx_copybutton = "*"
sphinx_tabs = "*"
pygments = "*"
pipenv = "*"
bump2version = "*"
47 changes: 21 additions & 26 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,34 +9,32 @@ this project's namesake.
Installing
~~~~~~~~~~

PyPI
^^^^

|PyPI|\ |PyPI - Wheel|
.. tabs::

.. code:: shell
.. tab:: PyPI

$ pip install Aspidites
|PyPI|\ |PyPI - Wheel|

Docker
^^^^^^
.. code:: shell
|Docker Image Version (latest by date)|\ |Docker Image Size (latest
semver)|
$ pip install Aspidites
.. code:: shell
.. tab:: Docker

$ docker pull ghcr.io/rjdbcm/aspidites:latest
|Docker Image Version (latest by date)|\ |Docker Image Size (latest semver)|

Github
^^^^^^
.. code:: shell
|GitHub release (latest SemVer)|\ |GitHub commits since tagged version
(branch)|
$ docker pull ghcr.io/rjdbcm/aspidites:latest
.. code:: shell
.. tab:: Github

|GitHub commits since tagged version (branch)|

.. code:: shell
$ gh repo clone rjdbcm/Aspidites
$ gh repo clone rjdbcm/Aspidites
Running
~~~~~~~
Expand Down Expand Up @@ -86,15 +84,12 @@ Goals
CPython.
- Usable for general purpose ***or*** scientific computing.

.. |GitHub release (latest SemVer)| image:: https://img.shields.io/github/v/release/rjdbcm/Aspidites?color=pink&label=&logo=github&logoColor=black
.. |GitHub commits since tagged version (branch)| image:: https://img.shields.io/github/commits-since/rjdbcm/Aspidites/latest/main
.. |PyPI| image:: https://img.shields.io/pypi/v/aspidites?color=pink&label=&logo=pypi
:target: https://pypi.org/project/Aspidites/
.. |PyPI - Wheel| image:: https://img.shields.io/pypi/wheel/Aspidites
:target: https://pypi.org/project/Aspidites/#files
.. |Docker Image Version (latest by date)| image:: https://img.shields.io/docker/v/rjdbcm/aspidites?color=pink&label=%20&logo=docker
.. |Docker Image Size (latest semver)| image:: https://img.shields.io/docker/image-size/rjdbcm/aspidites
:target: https://hub.docker.com/r/rjdbcm/aspidites/tags?page=1&ordering=last_updated
.. |GitHub release (latest SemVer)| image:: https://img.shields.io/github/v/release/rjdbcm/Aspidites?color=grey&label=%20&logo=github&style=for-the-badge
.. |GitHub commits since tagged version (branch)| image:: https://img.shields.io/github/commits-since/rjdbcm/Aspidites/latest/main?style=for-the-badge
.. |PyPI| image:: https://img.shields.io/pypi/v/aspidites?color=grey&label=%20&style=for-the-badge&logo=python
.. |PyPI - Wheel| image:: https://img.shields.io/pypi/wheel/Aspidites?logo=python&logoColor=lightblue&style=for-the-badge
.. |Docker Image Version (latest by date)| image:: https://img.shields.io/docker/v/rjdbcm/aspidites?color=grey&label=%20&logo=docker&style=for-the-badge
.. |Docker Image Size (latest semver)| image:: https://img.shields.io/docker/image-size/rjdbcm/aspidites?style=for-the-badge
.. |Continuous Integration| image:: https://github.com/rjdbcm/Aspidites/actions/workflows/python-app.yml/badge.svg
:target: https://github.com/rjdbcm/Aspidites/actions/workflows/python-app.yml
.. |Maintainability| image:: https://api.codeclimate.com/v1/badges/8d03ef8667df59d55380/maintainability
Expand Down
26 changes: 26 additions & 0 deletions docs/_static/css/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,32 @@ th p {
margin-bottom: 0;
}

.sphinx-tabs-panel {
background: rgba(54, 59, 61, 0) !important;
}

.sphinx-tabs-tab [aria-selected="true"] {
background-color: #1a1c1d;
margin: 0
}

.sphinx-tabs-tab {
position: relative;
font-family: Lato,'Helvetica Neue',Arial,Helvetica,sans-serif;
color: #c0bab2 !important;
line-height: 24px;
margin: 0;
font-size: 16px;
font-weight: 400;
background: #363b3d !important;
border-radius: 0px 0px 0px 0px;
border: 0px;
padding: 1rem 1.5rem;
margin-bottom: 0px;
margin-left: 2px !important;
}


a img.logo {
animation-duration: 0.75s;
animation-name: slidein;
Expand Down
4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,13 @@
# ones.
extensions = [
"sphinx_rtd_theme",
"sphinx_copybutton"
"sphinx_copybutton",
"sphinx_tabs.tabs"
]
copybutton_only_copy_prompt_lines = True
copybutton_prompt_text = "$ "
copybutton_selector = "div.highlight-shell pre"
sphinx_tabs_disable_tab_closing = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ Pygments==2.10.0
Cython==0.29.24
numpy==1.21.2
sphinx-copybutton==0.4.0
sphinx-tabs==3.2.0

0 comments on commit 01c8e23

Please sign in to comment.