Skip to content

docs: add command line full reference using sphinx-click #3065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Aug 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/_static/cheatsheet/cheatsheet.pdf
Binary file not shown.
9 changes: 7 additions & 2 deletions docs/_static/css/override-theme.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
.wy-nav-content {
max-width: 950px;
.cli-reference-commands > div.section {
margin-left: 15px;
}

.cli-reference-commands > div.section h4 {
margin-left: -15px;
font-style: italic;
}
1 change: 1 addition & 0 deletions docs/cheatsheet/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
extensions = [
"plantweb.directive",
"sphinx.ext.autodoc",
"sphinx_click",
"sphinx_tabs.tabs",
"sphinx.ext.napoleon",
"cheatsheet",
Expand Down
2 changes: 1 addition & 1 deletion docs/cheatsheet_hash
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
e76e9f0f1bdb504ab7571c0d89815d99 cheatsheet.tex
ebc07405e0961bf0895156e422ddc7d7 cheatsheet.tex
c70c179e07f04186ec05497564165f11 sdsc_cheatsheet.cls
4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
"sphinxcontrib.spelling",
"sphinx_click",
"sphinx_tabs.tabs",
"cheatsheet",
]
Expand Down Expand Up @@ -177,7 +178,8 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
html_static_path = ['_static']
html_css_files = ['css/override-theme.css']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
Expand Down
242 changes: 0 additions & 242 deletions docs/reference/commands.rst

This file was deleted.

6 changes: 6 additions & 0 deletions docs/reference/commands/clone.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _cli-clone:

renku clone
***********

.. automodule:: renku.ui.cli.clone
6 changes: 6 additions & 0 deletions docs/reference/commands/config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _cli-config:

renku config
************

.. automodule:: renku.ui.cli.config
6 changes: 6 additions & 0 deletions docs/reference/commands/dataset.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _cli-datasets:

renku dataset
*************

.. automodule:: renku.ui.cli.dataset
6 changes: 6 additions & 0 deletions docs/reference/commands/doctor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _cli-doctor:

renku doctor
************

.. automodule:: renku.ui.cli.doctor
6 changes: 6 additions & 0 deletions docs/reference/commands/env.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _cli-env:

renku env
*********

.. automodule:: renku.ui.cli.env
4 changes: 4 additions & 0 deletions docs/reference/commands/errors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Error Tracking
**************

.. automodule:: renku.ui.cli.exception_handler
6 changes: 6 additions & 0 deletions docs/reference/commands/gc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _cli-gc:

renku gc
********

.. automodule:: renku.ui.cli.gc
6 changes: 6 additions & 0 deletions docs/reference/commands/githooks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _cli-githooks:

renku githooks
**************

.. automodule:: renku.ui.cli.githooks
6 changes: 6 additions & 0 deletions docs/reference/commands/graph.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _cli-graph:

renku graph
***********

.. automodule:: renku.ui.cli.graph
Loading