Files
rmapy/docs/source/index.rst
Stijn Van Campenhout 00dc50550f Rename rmapi rmapy
2019-12-19 13:42:26 +01:00

64 lines
1.0 KiB
ReStructuredText

.. rmapy documentation master file, created by
sphinx-quickstart on Tue Sep 17 19:24:29 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to rmapy's documentation!
=================================
This is an (unofficial) Remarkable Cloud API Client written in Python.
.. toctree::
:maxdepth: 2
API Support
~~~~~~~~~~~
| ☑️ List content in the cloud
| ☑️ Work with documents & folders
| ☑️ create a folder
| ☑️ move / rename a document or folder
| ☑️ create a document
| ☑️ edit a document
| ☑️ delete a document or folder
| ❎ cli interface
| ❎ export pdf with annotations
Installation
~~~~~~~~~~~~
.. toctree::
:maxdepth: 2
installation
Quick start
~~~~~~~~~~~
.. toctree::
:maxdepth: 2
quickstart
API Documentation
~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 2
rmapy
.. automodule:: rmapy
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`