docs: deprecate RTD (#2280)

6 years ago · aab5947d82
--- a/docs/Makefile
+++ b/docs/Makefile
@ -1,23 +0,0 @@
 # Minimal makefile for Sphinx documentation
 #

 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = python -msphinx
 SPHINXPROJ    = Tendermint
 SOURCEDIR     = .
 BUILDDIR      = _build

 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

 install:
 	@pip install -r requirements.txt

 .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)
--- a/docs/conf.py
+++ b/docs/conf.py
@ -1,199 +0,0 @@
 # -*- coding: utf-8 -*-
 #
 # Tendermint documentation build configuration file, created by
 # sphinx-quickstart on Mon Aug  7 04:55:09 2017.
 #
 # 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('.'))
 import urllib

 import sphinx_rtd_theme


 # -- 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 = []

 # 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:
 #

 from recommonmark.parser import CommonMarkParser

 source_parsers = {
    '.md': CommonMarkParser,
 }

 source_suffix = ['.rst', '.md']
 #source_suffix = '.rst'

 # The master toctree document.
 master_doc = 'index'

 # General information about the project.
 project = u'Tendermint'
 copyright = u'2018, The Authors'
 author = u'Tendermint'

 # 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.
 #
 # The short X.Y version.
 version = u''
 # The full version, including alpha/beta/rc tags.
 release = u''

 # 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 = ['_build', 'Thumbs.db', '.DS_Store', 'architecture', 'spec', 'examples']

 # 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'
 # html_theme = 'alabaster'

 # 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 = {
    '**': [
        'about.html',
        'navigation.html',
        'relations.html',  # needs 'show_related': True theme option to display
        'searchbox.html',
        'donate.html',
    ]
 }


 # -- Options for HTMLHelp output ------------------------------------------

 # Output file base name for HTML help builder.
 htmlhelp_basename = 'Tendermintdoc'


 # -- 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, 'Tendermint.tex', u'Tendermint Documentation',
     u'The Authors', '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, 'Tendermint', u'Tendermint 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, 'Tendermint', u'Tendermint Documentation',
     author, 'Tendermint', 'Byzantine Fault Tolerant Consensus.',
     'Database'),
 ]

 # ---------------- customizations ----------------------

 # for Docker README, below
 from shutil import copyfile

 # tm-bench and tm-monitor
 tools_repo = "https://raw.githubusercontent.com/tendermint/tools/"
 tools_branch = "master"

 tools_dir = "./tools"


 if os.path.isdir(tools_dir) != True:
    os.mkdir(tools_dir)

 copyfile('../DOCKER/README.md', tools_dir+'/docker.md')

 urllib.urlretrieve(tools_repo+tools_branch+'/tm-bench/README.md', filename=tools_dir+'/benchmarking.md')
 urllib.urlretrieve(tools_repo+tools_branch+'/tm-monitor/README.md', filename=tools_dir+'/monitoring.md')
--- a/docs/index.rst
+++ b/docs/index.rst
@ -1,15 +0,0 @@
 .. Tendermint documentation master file, created by
   sphinx-quickstart on Mon Aug  7 04:55:09 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

 Welcome to Tendermint!
 ======================

 This location for our documentation has been deprecated, please see:

 - https://tendermint.com/docs/

 The last version built by Read The Docs will still be available at:

 - https://tendermint.readthedocs.io/projects/tools/en/v0.21.0/
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@ -1,4 +0,0 @@
 sphinx
 sphinx-autobuild
 recommonmark
 sphinx_rtd_theme