Merge pull request #575 from rachmadaniHaryono/feature/docs

docs update

docs/source/bukuserver.rst

@@ -0,0 +1,42 @@
+bukuserver package
+==================
+
+bukuserver.filters module
+-------------------------
+
+.. automodule:: bukuserver.filters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bukuserver.forms module
+-----------------------
+
+.. automodule:: bukuserver.forms
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bukuserver.response module
+--------------------------
+
+.. automodule:: bukuserver.response
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bukuserver.server module
+------------------------
+
+.. automodule:: bukuserver.server
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bukuserver.views module
+-----------------------
+
+.. automodule:: bukuserver.views
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/conf.py

@@ -19,9 +19,8 @@
 #
 import os
 import sys
-from recommonmark.parser import CommonMarkParser
+
 sys.path.insert(0, os.path.abspath('../../'))
-# sys.path.insert(0, os.path.abspath('../'))
 
 
 # -- General configuration ------------------------------------------------
@@ -33,28 +32,30 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc',
-              'sphinx.ext.viewcode',
-              'sphinx.ext.autosummary',
-              'sphinx.ext.napoleon']
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-source_parsers = {'.md': CommonMarkParser}
 source_suffix = ['.rst', '.md']
-# source_suffix = '.rst'
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
-project = 'buku'
-copyright = '2018, Arun Prakash Jana'
-author = 'Arun Prakash Jana'
+project = "buku"
+copyright = "2022, Arun Prakash Jana"
+author = "Arun Prakash Jana"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/source/index.rst

@@ -15,11 +15,26 @@ Bookmark manager like a text-based mini-web.
    README.md
 
 .. toctree::
+   :glob:
    :maxdepth: 2
-   :caption: Documentation
+   :caption: Wiki
+
+   wiki/*
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Buku Documentation
 
    buku <buku>
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Bukuserver Documentation
+
+   bukuserver <bukuserver>
+
+
 Indices and tables
 ==================
 

docs/source/modules.rst

@@ -0,0 +1,16 @@
+buku
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   buku
+
+bukuserver
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   bukuserver
+

setup.py

@@ -84,10 +84,15 @@
         'console_scripts': ['buku=buku:main', 'bukuserver=bukuserver.server:cli']
     },
     extras_require={
-        'ca-certificates': ['certifi'],
-        'tests': tests_require + server_require,
-        'server': server_require,
-        'packaging': ['twine>=1.11.0']
+        "ca-certificates": ["certifi"],
+        "tests": tests_require + server_require,
+        "server": server_require,
+        "docs": [
+            "myst-parser>=0.17.0",
+            "sphinx-rtd-theme>=1.0.0",
+            "sphinx-autobuild>=2021.3.14",
+        ],
+        "packaging": ["twine>=1.11.0"],
     },
     test_suite='tests',
     tests_require=tests_require,