From c8eac7e9329f53bed3e2dea997beace3c84d0aca Mon Sep 17 00:00:00 2001 From: ke-zhang-rd Date: Thu, 2 Apr 2020 12:50:43 -0400 Subject: [PATCH] DOC: Centralize documentation.md --- .travis.yml | 1 - CHANGELOG.md | 22 ++++ README.md | 8 ++ docs/Makefile | 20 --- docs/make.bat | 36 ------ docs/source/_static/.placeholder | 0 docs/source/conf.py | 202 ------------------------------- docs/source/index.rst | 14 --- docs/source/installation.rst | 7 -- docs/source/release-history.rst | 6 - docs/source/usage.rst | 9 -- requirements-dev.txt | 7 -- 12 files changed, 30 insertions(+), 302 deletions(-) create mode 100644 CHANGELOG.md delete mode 100644 docs/Makefile delete mode 100644 docs/make.bat delete mode 100644 docs/source/_static/.placeholder delete mode 100644 docs/source/conf.py delete mode 100644 docs/source/index.rst delete mode 100644 docs/source/installation.rst delete mode 100644 docs/source/release-history.rst delete mode 100644 docs/source/usage.rst diff --git a/.travis.yml b/.travis.yml index 1dc7406..faa0ab2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,4 +19,3 @@ script: - coverage report -m # Generate test coverage report. - codecov # Upload the report to codecov. - flake8 --max-line-length=115 # Enforce code style (but relax line length limit a bit). - - make -C docs html # Build the documentation. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e5905d7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,22 @@ +# suitcase-mongo changes + +## v0.2.0 (2020-03-13) + +## v0.1.2 (2020-03-11) + +## v0.1.1 (2019-10-18) + +## v0.1.0 (2019-05-03) + +## v0.1.0rc1 (2019-04-24) + +## v0.1.0b5 (2019-04-02) + +## v0.1.0b4 (2019-02-14) + +## v0.1.0b3 (2019-02-14) + +## v0.1.0b2 (2019-02-13) + +## v0.1.0b1 (2019-02-08) + diff --git a/README.md b/README.md index 9bd1a1b..2ac9702 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,11 @@ contains two packages: ``` pip install suitcase-mongo ``` + +## Quick Start + +TODO + +## Documentation + +See the [suitcase documentation](https://nsls-ii.github.io/suitcase). diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index b4a5893..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = "-W" # This flag turns warnings into errors. -SPHINXBUILD = sphinx-build -SPHINXPROJ = PackagingScientificPython -SOURCEDIR = source -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) diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 2be8306..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,36 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build -set SPHINXPROJ=PackagingScientificPython - -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.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% - -:end -popd diff --git a/docs/source/_static/.placeholder b/docs/source/_static/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index 5b3371d..0000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,202 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -# -# mongo documentation build configuration file, created by -# sphinx-quickstart on Thu Jun 28 12:35:56 2018. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# 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('.')) - - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# 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.autosummary', - 'sphinx.ext.githubpages', - 'sphinx.ext.intersphinx', - 'sphinx.ext.mathjax', - 'sphinx.ext.viewcode', - 'IPython.sphinxext.ipython_directive', - 'IPython.sphinxext.ipython_console_highlighting', - 'matplotlib.sphinxext.plot_directive', - 'numpydoc', - 'sphinx_copybutton', -] - -# Configuration options for plot_directive. See: -# https://github.com/matplotlib/matplotlib/blob/f3ed922d935751e08494e5fb5311d3050a3b637b/lib/matplotlib/sphinxext/plot_directive.py#L81 -plot_html_show_source_link = False -plot_html_show_formats = False - -# Generate the API documentation when building -autosummary_generate = True -numpydoc_show_class_members = False - -# 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_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = 'suitcase.mongo_embedded' -copyright = 'suitcase.mongo Contributors' -author = 'suitcase.mongo Contributors' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -import suitcase.mongo_embedded -# The short X.Y version. -version = suitcase.mongo_embedded.__version__ -# The full version, including alpha/beta/rc tags. -release = version - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = [] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- 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' -import sphinx_rtd_theme -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# 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'] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -html_sidebars = { - '**': [ - 'relations.html', # needs 'show_related': True theme option to display - 'searchbox.html', - ] -} - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = 'mongo' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'mongo.tex', 'mongo Documentation', - 'Contributors', 'manual'), -] - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'mongo', 'mongo Documentation', - [author], 1) -] - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'mongo', 'mongo Documentation', - author, 'mongo', '', - 'Miscellaneous'), -] - - - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - 'python': ('https://docs.python.org/3/', None), - 'numpy': ('https://docs.scipy.org/doc/numpy/', None), - 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None), - 'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None), - 'matplotlib': ('https://matplotlib.org', None), -} diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index 5c2ca2c..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. Packaging Scientific Python documentation master file, created by - sphinx-quickstart on Thu Jun 28 12:35:56 2018. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -suitcase.mongo Documentation -============================ - -.. toctree:: - :maxdepth: 2 - - installation - usage - release-history diff --git a/docs/source/installation.rst b/docs/source/installation.rst deleted file mode 100644 index f0893e8..0000000 --- a/docs/source/installation.rst +++ /dev/null @@ -1,7 +0,0 @@ -============ -Installation -============ - -At the command line:: - - $ pip install suitcase-mongo diff --git a/docs/source/release-history.rst b/docs/source/release-history.rst deleted file mode 100644 index 53707fb..0000000 --- a/docs/source/release-history.rst +++ /dev/null @@ -1,6 +0,0 @@ -=============== -Release History -=============== - -Initial Release (YYYY-MM-DD) ----------------------------- diff --git a/docs/source/usage.rst b/docs/source/usage.rst deleted file mode 100644 index 705d7bb..0000000 --- a/docs/source/usage.rst +++ /dev/null @@ -1,9 +0,0 @@ -===== -Usage -===== - -Start by importing ``suitcase.mongo``. - -.. code-block:: python - - import suitcase.mongo diff --git a/requirements-dev.txt b/requirements-dev.txt index 307a005..0ba0039 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -5,13 +5,6 @@ codecov coverage flake8 pytest >=3.9 -sphinx suitcase-utils[test_fixtures] >=0.1.0rc2 -# These are dependencies of various sphinx extensions for documentation. -ipython -matplotlib -numpydoc -sphinx-copybutton -sphinx_rtd_theme # TEMPORARY UNTIL https://github.com/NSLS-II/ophyd/pull/682 IS RELEASED git+git://github.com/NSLS-II/ophyd@ophyd-for-suitcase-utils