From 11781de1056c615dd44e33d4533fdc516c64a5df Mon Sep 17 00:00:00 2001 From: Andrew Halberstadt Date: Sun, 22 Oct 2023 21:57:00 -0400 Subject: [PATCH] chore: remove 'docs' folder This is simple enough that we can just add docs to the README to start. --- Makefile | 23 ------------------- docs/concepts/index.rst | 2 -- docs/conf.py | 49 ---------------------------------------- docs/howto/index.rst | 2 -- docs/index.rst | 16 ------------- docs/reference/index.rst | 2 -- docs/tutorials/index.rst | 2 -- 7 files changed, 96 deletions(-) delete mode 100644 Makefile delete mode 100644 docs/concepts/index.rst delete mode 100644 docs/conf.py delete mode 100644 docs/howto/index.rst delete mode 100644 docs/index.rst delete mode 100644 docs/reference/index.rst delete mode 100644 docs/tutorials/index.rst diff --git a/Makefile b/Makefile deleted file mode 100644 index ad4d8ca..0000000 --- a/Makefile +++ /dev/null @@ -1,23 +0,0 @@ -# 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 = ./docs -BUILDDIR = ./docs/_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) - -livehtml: - sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/concepts/index.rst b/docs/concepts/index.rst deleted file mode 100644 index 6b79979..0000000 --- a/docs/concepts/index.rst +++ /dev/null @@ -1,2 +0,0 @@ -Concepts -======== diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 42b9c81..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,49 +0,0 @@ -# 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 -# sys.path.insert(0, os.path.abspath('.')) - - -# -- Project information ----------------------------------------------------- - -project = "simple-github-client" -copyright = "2023" -author = "Mozilla Release Engineering " - - -# -- 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.napoleon", -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# 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 = ["docs/_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_book_theme" diff --git a/docs/howto/index.rst b/docs/howto/index.rst deleted file mode 100644 index e7452d2..0000000 --- a/docs/howto/index.rst +++ /dev/null @@ -1,2 +0,0 @@ -How-To Guides -============= diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index bac46df..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -simple-github-client -==================== - -A simple Github client that only provides auth and access to the REST and GraphQL APIs. - - -Table of Contents ------------------ - -.. toctree:: - :maxdepth: 2 - - tutorials/index - howto/index - concepts/index - reference/index diff --git a/docs/reference/index.rst b/docs/reference/index.rst deleted file mode 100644 index 9a771c8..0000000 --- a/docs/reference/index.rst +++ /dev/null @@ -1,2 +0,0 @@ -Reference -========= diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst deleted file mode 100644 index 0c7e28c..0000000 --- a/docs/tutorials/index.rst +++ /dev/null @@ -1,2 +0,0 @@ -Tutorials -=========