sphinx: doc init

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,77 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# This will include the necessary source files folders in the PATH to be able to generate the documentation from.
+# devdir=r'C:\Users\parkm\Desktop\git\ExceptionNotifier'
+# try:
+#     if os.environ['DEVDIR']:
+#         devdir = os.environ['DEVDIR'] 
+# except KeyError:
+#     print('Unable to obtain $DEVDIR from the environment.')
+#     pass
+
+sys.path.insert(0, os.path.abspath('../..'))
+sys.setrecursionlimit(1500)
+
+
+# Ensure that the __init__ method gets documented.
+def skip(app, what, name, obj, skip, options):
+    if name == "__init__":
+        return False
+    return skip
+
+# -- Project information -----------------------------------------------------
+
+project = 'bardapi'
+copyright = '2024, minwoo park'
+author = 'minwoo park'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1.39'
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.todo'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+todo_include_todos = True
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# 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']

docs/index.rst

@@ -0,0 +1,20 @@
+.. bardapi documentation master file, created by
+   sphinx-quickstart on Tue Jan 23 19:33:51 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to bardapi's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/bardapi.models.rst

@@ -0,0 +1,61 @@
+bardapi.models package
+======================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   bardapi.models.tools
+
+Submodules
+----------
+
+bardapi.models.citation module
+------------------------------
+
+.. automodule:: bardapi.models.citation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.draft module
+---------------------------
+
+.. automodule:: bardapi.models.draft
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.image module
+---------------------------
+
+.. automodule:: bardapi.models.image
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.result module
+----------------------------
+
+.. automodule:: bardapi.models.result
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.user\_content module
+-----------------------------------
+
+.. automodule:: bardapi.models.user_content
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: bardapi.models
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/bardapi.models.tools.rst

@@ -0,0 +1,101 @@
+bardapi.models.tools package
+============================
+
+Submodules
+----------
+
+bardapi.models.tools.code module
+--------------------------------
+
+.. automodule:: bardapi.models.tools.code
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.tools.flight module
+----------------------------------
+
+.. automodule:: bardapi.models.tools.flight
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.tools.gdocs module
+---------------------------------
+
+.. automodule:: bardapi.models.tools.gdocs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.tools.gworkspace module
+--------------------------------------
+
+.. automodule:: bardapi.models.tools.gworkspace
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.tools.hotel module
+---------------------------------
+
+.. automodule:: bardapi.models.tools.hotel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.tools.json module
+--------------------------------
+
+.. automodule:: bardapi.models.tools.json
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.tools.link module
+--------------------------------
+
+.. automodule:: bardapi.models.tools.link
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.tools.map module
+-------------------------------
+
+.. automodule:: bardapi.models.tools.map
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.tools.tool module
+--------------------------------
+
+.. automodule:: bardapi.models.tools.tool
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.tools.tool\_declaimer module
+-------------------------------------------
+
+.. automodule:: bardapi.models.tools.tool_declaimer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bardapi.models.tools.youtube module
+-----------------------------------
+
+.. automodule:: bardapi.models.tools.youtube
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: bardapi.models.tools
+   :members:
+   :undoc-members:
+   :show-inheritance: