From bdd50c5f3750238fbd60948cd1a747f9016e50d9 Mon Sep 17 00:00:00 2001 From: Zach Date: Mon, 5 Mar 2018 20:30:36 +0800 Subject: [PATCH] fix docs links & stuff (#1273) * fix links in docs/spec etc, closes #1261 * spec: remove ref to non-existant repo * codecov you weirdo --- codecov.yml | 5 ---- docs/abci-cli.rst | 2 +- docs/conf.py | 10 ++++---- docs/ecosystem.rst | 2 +- docs/index.rst | 2 +- docs/specification.rst | 3 ++- docs/specification/new-spec/README.md | 23 +++++++------------ .../reactors/consensus/consensus-reactor.md | 2 +- .../new-spec/reactors/consensus/consensus.md | 2 +- 9 files changed, 20 insertions(+), 31 deletions(-) diff --git a/codecov.yml b/codecov.yml index 3ef46b7ff..6db0f15d5 100644 --- a/codecov.yml +++ b/codecov.yml @@ -16,8 +16,3 @@ comment: require_changes: no require_base: no require_head: yes - -ignore: - - "docs" - - "*.md" - - "*.rst" diff --git a/docs/abci-cli.rst b/docs/abci-cli.rst index 9162682c3..4cdd9b234 100644 --- a/docs/abci-cli.rst +++ b/docs/abci-cli.rst @@ -57,7 +57,7 @@ Now run ``abci-cli`` to see the list of commands: KVStore - First Example ---------------------- +----------------------- The ``abci-cli`` tool lets us send ABCI messages to our application, to help build and debug them. diff --git a/docs/conf.py b/docs/conf.py index 92c5e1201..6122e90a3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,15 +41,15 @@ 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' +#source_suffix = ['.rst', '.md'] +source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = u'Tendermint' -copyright = u'2017, The Authors' +copyright = u'2018, The Authors' author = u'Tendermint' # The version info for the project you're documenting, acts as replacement for @@ -71,7 +71,7 @@ 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'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'architecture', 'specification/new-spec', 'examples'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' @@ -203,6 +203,6 @@ urllib.urlretrieve(tools_repo+tools_branch+'/tm-bench/README.rst', filename=tool #### abci spec ################################# abci_repo = "https://raw.githubusercontent.com/tendermint/abci/" -abci_branch = "spec-docs" +abci_branch = "develop" urllib.urlretrieve(abci_repo+abci_branch+'/specification.rst', filename='abci-spec.rst') diff --git a/docs/ecosystem.rst b/docs/ecosystem.rst index 39e6785ee..cfd3a6e55 100644 --- a/docs/ecosystem.rst +++ b/docs/ecosystem.rst @@ -5,7 +5,7 @@ The growing list of applications built using various pieces of the Tendermint st * https://tendermint.com/ecosystem -We thank the community for their contributions thus far and welcome the addition of new projects. A pull request can be submitted to `this file `__ to include your project. +We thank the community for their contributions thus far and welcome the addition of new projects. A pull request can be submitted to `this file `__ to include your project. Other Tools ----------- diff --git a/docs/index.rst b/docs/index.rst index b32ba4841..14c1b8062 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -71,4 +71,4 @@ Tendermint 201 * Readers might also be interested in the `Cosmos Whitepaper `__ which describes Tendermint, ABCI, and how to build a scalable, heterogeneous, cryptocurrency network. * For example applications and related software built by the Tendermint team and other, see the `software ecosystem `__. -Join the `Cosmos and Tendermint Rocket Chat `__ to ask questions and discuss projects. +Join the `community `__ to ask questions and discuss projects. diff --git a/docs/specification.rst b/docs/specification.rst index 3afa9c659..70ebf633f 100644 --- a/docs/specification.rst +++ b/docs/specification.rst @@ -2,7 +2,7 @@ Specification ############# -Here you'll find details of the Tendermint specification. See `the spec repo `__ for upcoming material. Tendermint's types are produced by `godoc `__. +Here you'll find details of the Tendermint specification. Tendermint's types are produced by `godoc `__. .. toctree:: :maxdepth: 2 @@ -10,6 +10,7 @@ Here you'll find details of the Tendermint specification. See `the spec repo