updated doc titles

2024-09-22 11:27:35 +03:00 · 2020-04-02 21:47:28 +01:00 · 2020-04-02 21:47:28 +01:00 · 0f21a3be3d
commit 0f21a3be3d
parent ddf3acd43f
22 changed files with 56 additions and 72 deletions
--- a/docs/_static/custom.css
+++ b/docs/_static/custom.css
@ -1,51 +1,10 @@
-:root {
-    --color-primary: rgb(68, 68, 68);
-    --color-secondary: #f2f2f2;
-    --color-background: #ffffff;
-}

-/* sidebar header (and topbar for mobile) */
- .wy-side-nav-search, .wy-nav-top {
-   background: var(--color-secondary);
- }
-
- .wy-side-nav-search input[type=text] {
-    border-color: #202448;
+.wy-side-nav-search > a img.logo, .wy-side-nav-search .wy-dropdown > a img.logo {
+    display: block;
+    margin: 0 auto;
+    height: auto;
+    width: auto;
+    border-radius: 0;
+    max-width: 50%;
+    background:transparent
 }
-
-/* sidebar */
- .wy-nav-side {
-   background: var(--color-secondary);
-}
-
-/* links outside nav */
-.rst-content a:link, .rst-content a:visited {
-   color: var(--color-primary);
-   text-decoration: none;
- }
-
-/* admonitions only */
-.admonition.note {
-   background: var(--color-background);
-}
-
-/* font size smaller and striped cols in notebook tables */
-.output_area {
-    font-size: 12px;
-}
-.output_area tr:nth-child(even) {background-color: var(--color-background);}
-th {
-    background-color: #f2f2f2;
-    padding-right: 8px;
-    text-align: left;
-}
-
-/* font size smaller and not-stripped cols in API tables */
-table.docutils {
-    font-size: 14px;
-}
-.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,
-.wy-table-striped tr:nth-child(2n-1) td,
-.wy-table-odd td {
-     background-color: #fff;
-}
--- a/docs/api/cli.rst
+++ b/docs/api/cli.rst
@ -1,6 +1,6 @@

-Maestral
-========
+Command line interface
+======================

 .. automodule:: cli
   :members:
--- a/docs/api/client.rst
+++ b/docs/api/client.rst
@ -1,6 +1,6 @@

-Maestral
-========
+Dropbox API client
+==================

 .. automodule:: client
   :members:
--- a/docs/api/daemon.rst
+++ b/docs/api/daemon.rst
@ -1,6 +1,6 @@

-Maestral
-========
+Daemon
+======

 .. automodule:: daemon
   :members:
--- a/docs/api/errors.rst
+++ b/docs/api/errors.rst
@ -1,6 +1,6 @@

-Maestral
-========
+Errors
+======

 .. automodule:: errors
   :members:
--- a/docs/api/main.rst
+++ b/docs/api/main.rst
@ -1,5 +1,5 @@

-Maestral
+Main API
 ========

 .. automodule:: main
--- a/docs/api/oauth.rst
+++ b/docs/api/oauth.rst
@ -1,6 +1,6 @@

-Maestral
-========
+OAuth
+=====

 .. automodule:: oauth
   :members:
--- a/docs/api/sync.rst
+++ b/docs/api/sync.rst
@ -1,6 +1,6 @@

-Sync
-====
+Sync module
+===========

 .. automodule:: sync
   :members:
--- a/docs/api/utils/appdirs.rst
+++ b/docs/api/utils/appdirs.rst
@ -1,4 +1,7 @@

+App directories
+===============
+
 .. automodule:: appdirs
   :members:
   :show-inheritance:
--- a/docs/api/utils/autostart.rst
+++ b/docs/api/utils/autostart.rst
@ -1,4 +1,7 @@

+Autostart
+=========
+
 .. automodule:: autostart
   :members:
   :show-inheritance:
--- a/docs/api/utils/backend.rst
+++ b/docs/api/utils/backend.rst
@ -1,4 +1,7 @@

+Backend functions
+=================
+
 .. automodule:: backend
   :members:
   :show-inheritance:
--- a/docs/api/utils/content_hasher.rst
+++ b/docs/api/utils/content_hasher.rst
@ -1,4 +1,7 @@

+Content hasher
+==============
+
 .. automodule:: content_hasher
   :members:
   :show-inheritance:
--- a/docs/api/utils/dbus_interfaces.rst
+++ b/docs/api/utils/dbus_interfaces.rst
@ -1,4 +1,7 @@

+DBus interfaces
+===============
+
 .. automodule:: dbus_interfaces
   :members:
   :show-inheritance:
--- a/docs/api/utils/housekeeping.rst
+++ b/docs/api/utils/housekeeping.rst
@ -1,4 +1,7 @@

+Housekeeping
+============
+
 .. automodule:: housekeeping
   :members:
   :show-inheritance:
--- a/docs/api/utils/index.rst
+++ b/docs/api/utils/index.rst
@ -1,6 +1,6 @@

-Utils
-=======
+maestral.utils
+==============

 .. toctree::
   :maxdepth: 2
--- a/docs/api/utils/notify.rst
+++ b/docs/api/utils/notify.rst
@ -1,4 +1,7 @@

+Desktop notifications
+=====================
+
 .. automodule:: notify
   :members:
   :show-inheritance:
--- a/docs/api/utils/oauth_implicit.rst
+++ b/docs/api/utils/oauth_implicit.rst
@ -1,4 +1,7 @@

+OAuth implicit flow
+===================
+
 .. automodule:: oauth_implicit
   :members:
   :show-inheritance:
--- a/docs/api/utils/path.rst
+++ b/docs/api/utils/path.rst
@ -1,4 +1,7 @@

+Path handling
+=============
+
 .. automodule:: path
   :members:
   :show-inheritance:
--- a/docs/api/utils/serializer.rst
+++ b/docs/api/utils/serializer.rst
@ -1,4 +1,7 @@

+Serializer helpers
+==================
+
 .. automodule:: serializer
   :members:
   :show-inheritance:
--- a/docs/api/utils/updates.rst
+++ b/docs/api/utils/updates.rst
@ -1,4 +1,7 @@

+Update checks
+=============
+
 .. automodule:: updates
   :members:
   :show-inheritance:
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@ -1,7 +1,3 @@
-.. customxepr documentation master file, created by
-   sphinx-quickstart on Wed Jan 30 23:05:36 2019.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.

 Changelog
 =========
--- a/docs/index.rst
+++ b/docs/index.rst
@ -1,7 +1,3 @@
-.. customxepr documentation master file, created by
-   sphinx-quickstart on Wed Jan 30 23:05:36 2019.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.

 Welcome to Maestral's developer documentation
 =============================================