diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index b3eb2c3..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,49 +0,0 @@ -import os -import sys - -# 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 - -sys.path.insert(0, os.path.abspath('..')) - -project = "topenai" -copyright = "" -author = "vladzima" -release = "<>" - -# -- 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.coverage", - "sphinx.ext.napoleon", - "sphinx.ext.intersphinx" -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = [] - -# 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 = ["build", "Thumbs.db", ".DS_Store"] - - -# -- 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'] - diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 4499d03..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. python-package-automation documentation master file, created by - sphinx-quickstart on Wed Oct 21 14:00:09 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to topenai's documentation! -===================================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - reference - setup - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/reference.rst b/docs/reference.rst deleted file mode 100644 index b093d4e..0000000 --- a/docs/reference.rst +++ /dev/null @@ -1,6 +0,0 @@ -Reference -========= - - -.. automodule:: topenai - :members: diff --git a/docs/setup.rst b/docs/setup.rst deleted file mode 100644 index 04f6a0a..0000000 --- a/docs/setup.rst +++ /dev/null @@ -1,36 +0,0 @@ -Setup -===== - -To install this package, run: - -.. code-block:: bash - - pip install topenai - -To install the latest testing version (may contain bugs), run: - -.. code-block:: bash - - pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ topenai - -.. note:: - - On some systems (especially linux), :code:`pip` may be known as :code:`pip3` - -Developing Setup ----------------- - -If you want to set this package up for directly editing it's source code (for contributing): - -1. Clone the package - - .. code-block:: bash - - git clone https://github.com/vladzima/topenai - -2. Create a dynamic link - This will make the package dynamically update with your local changes: - - .. code-block:: bash - - pip install -e .