Skip to content

Commit

Permalink
docs: add missing sphinx pages
Browse files Browse the repository at this point in the history
Includes documentation for
- ManagedService
- Organization
- VPN
- Parameter
  • Loading branch information
pallabpain committed May 9, 2023
1 parent bd9081c commit 5eee7d6
Show file tree
Hide file tree
Showing 9 changed files with 91 additions and 2 deletions.
22 changes: 22 additions & 0 deletions docs/source/apply.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Apply
=====

.. toctree::
:maxdepth: 3
:caption: Contents:

.. click:: riocli.apply:apply
:prog: rio apply
:nested: full

.. click:: riocli.apply:delete
:prog: rio delete
:nested: full

.. click:: riocli.apply:template
:prog: rio template
:nested: full

.. click:: riocli.apply:explain
:prog: rio explain
:nested: full
10 changes: 10 additions & 0 deletions docs/source/chart.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Chart
=====

.. toctree::
:maxdepth: 3
:caption: Contents:

.. click:: riocli.chart:chart
:prog: rio chart
:nested: full
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import sys

project = u'Rapyuta.io CLI'
copyright = u'2021, Rapyuta Robotics'
copyright = u'2023, Rapyuta Robotics'
author = u'Rapyuta Robotics'

sys.path.insert(0, os.path.abspath('../..'))
Expand Down
10 changes: 10 additions & 0 deletions docs/source/disk.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Disk
====

.. toctree::
:maxdepth: 3
:caption: Contents:

.. click:: riocli.disk:disk
:prog: rio disk
:nested: full
9 changes: 8 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,24 @@ Rapyuta CLI has commands for all rapyuta.io resources. You can read more about t
.. toctree::
:maxdepth: 1

Apply <apply>
Authentication <auth>
Build <build>
Chart <chart>
Completion <completion>
Deployment <deployment>
Device <device>
Disk <disk>
ManagedService <managedservice>
Network <network>
Organization <organization>
Package <package>
Parameter <parameter>
Project <project>
Rosbag <rosbag>
Secret <secret>
Static Routes <static_route>
Static Route <static_route>
VPN <vpn>



Expand Down
10 changes: 10 additions & 0 deletions docs/source/managedservice.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Managed Service
===============

.. toctree::
:maxdepth: 3
:caption: Contents:

.. click:: riocli.managedservice:managedservice
:prog: rio managedservice
:nested: full
10 changes: 10 additions & 0 deletions docs/source/organization.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Organization
============

.. toctree::
:maxdepth: 3
:caption: Contents:

.. click:: riocli.organization:organization
:prog: rio organization
:nested: full
10 changes: 10 additions & 0 deletions docs/source/parameter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Parameter
=========

.. toctree::
:maxdepth: 3
:caption: Contents:

.. click:: riocli.parameter:parameter
:prog: rio parameter
:nested: full
10 changes: 10 additions & 0 deletions docs/source/vpn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
VPN
======

.. toctree::
:maxdepth: 3
:caption: Contents:

.. click:: riocli.vpn:vpn
:prog: rio vpn
:nested: full

0 comments on commit 5eee7d6

Please sign in to comment.