Merge pull request #52 from weaveworks/rtd-support

add initial rtd support

.circleci/config.yml

@@ -46,6 +46,7 @@ jobs:
       - setup_remote_docker
       - run: make
       - run: make lint
+      - run: make test-docs
       - run:
           name: Check that generated files haven't been changed since checkout
           command: |

.gitignore

@@ -27,3 +27,6 @@ terraform.tfstate
 terraform.tfstate.backup
 .terraform.tfstate.lock.info
 tf.json
+
+# Docs
+docs/_build

.readthedocs.yaml

@@ -0,0 +1,23 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to the project
 
-Our doc on [developing `wksctl`](docs/development.md) will be helpful when getting started contributing as well.
+Our doc on [developing `wksctl`](https://wksctl.readthedocs.io/en/latest/development.html) will be helpful when getting started contributing as well.
 
 ## Typical workflow
 

Makefile

@@ -9,6 +9,8 @@ GIT_REVISION := $(shell git rev-parse HEAD)
 VERSION=$(shell git describe --always)
 UPTODATE := .uptodate
 
+DOCS_PORT:=8000
+
 # Every directory with a Dockerfile in it builds an image called
 # $(IMAGE_PREFIX)<dirname>. Dependencies (i.e. things that go in the image)
 # still need to be explicitly declared.
@@ -141,3 +143,14 @@ integration-tests-container: cmd/wksctl/wksctl cmd/controller/.uptodate
 	IMAGE_TAG=$(IMAGE_TAG) go test -v -timeout 20m ./test/integration/container/...
 
 FORCE:
+
+
+build-docs:
+	@cd docs && docker build -t wksctl-docs .
+
+test-docs: build-docs
+	@docker run -it wksctl-docs /usr/bin/linkchecker _build/html/index.html
+
+serve-docs: build-docs
+	@echo Stating docs website on http://localhost:${DOCS_PORT}/_build/html/index.html
+	@docker run -i -p ${DOCS_PORT}:8000 -e USER_ID=$$UID wksctl-docs

README.md

@@ -23,15 +23,16 @@ chmod +x wksctl
 sudo mv wksctl /usr/local/bin/
 ```
 
-Check out [our Get Started doc](docs/get-started.md) to dive deeper into the different ways to operate `wksctl`.
+Check out [our Get Started doc](https://wksctl.readthedocs.io/en/latest/get-started.html) to dive deeper into the different ways to operate `wksctl`.
 
 ## Quick start
 
 We put together a couple of guides to get you up and running with WKS in combination with [Footloose](https://github.com/weaveworks/footloose), [Vagrant](https://www.vagrantup.com) and others!
 
-- [WKS and Footloose](docs/wks-and-footloose.md) - this includes the Firekube approach (WKS+Footloose+Ignite)
-- [WKS and Vagrant](docs/wks-and-vagrant.md)
-- [WKS on GCE](docs/wks-on-gce.md)
+- [Firekube](https://github.com/weaveworks/wks-quickstart-firekube) - use our WKS + Footloose + Ignite demo and be up and running in no time
+- [WKS and Footloose](https://wksctl.readthedocs.io/en/latest/wks-and-footloose.html)
+- [WKS and Vagrant](https://wksctl.readthedocs.io/en/latest/wks-and-vagrant.html)
+- [WKS on GCE](https://wksctl.readthedocs.io/en/latest/wks-on-gce.html)
 
 ## Contributing
 
@@ -40,12 +41,12 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md) and our [Code Of Conduct](CODE_OF_
 Other interesting resources include:
 
 - [The issue tracker](https://github.com/weaveworks/wksctl/issues)
-- [Developing `wksctl`](docs/development.md)
+- [Developing `wksctl`](https://wksctl.readthedocs.io/en/latest/development.html)
 
 ## More Documentation
 
-- [Frequently asked questions](docs/faq.md)
-- [Developing `wksctl`](docs/development.md)
+- [Frequently asked questions](https://wksctl.readthedocs.io/en/latest/faq.html)
+- [Developing `wksctl`](https://wksctl.readthedocs.io/en/latest/development.html)
 
 ## Getting Help
 

docs/Dockerfile

@@ -0,0 +1,16 @@
+FROM ddidier/sphinx-doc
+
+COPY requirements.txt .
+
+RUN apt update && apt install -y linkchecker && \
+    pip install -r requirements.txt
+
+WORKDIR /doc
+
+COPY . .
+
+RUN make html && \
+    cd /doc/_build/html/_static/fonts/RobotoSlab && \
+    ln -s roboto-slab-v7-regular.eot roboto-slab.eot
+
+CMD ["python", "-m", "http.server", "8000"]

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+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)

docs/_static/custom.css

@@ -0,0 +1,15 @@
+@import url("https://fonts.googleapis.com/css?family=Montserrat&display=swap");
+@import url("https://fonts.googleapis.com/css?family=Roboto+Mono&display=swap");
+
+body {
+  font-family: "Montserrat", sans-serif;
+}
+
+.rst-content pre.literal-block, .rst-content div[class^="highlight"] pre, .rst-content .linenodiv pre {
+  font-family: "Roboto Mono", monospace;
+}
+
+code {
+  font-family: "Roboto Mono", monospace;
+}
+

docs/conf.py

@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 = 'wksctl'
+copyright = '2019, wksctl development team'
+author = 'wksctl development team'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- 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 = [
+    'recommonmark',
+    'sphinx_markdown_tables',
+]
+
+# 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']
+
+# The master toctree document.
+master_doc = 'index'
+
+# 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 pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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'
+
+# 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.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'wksctldoc'
+
+
+# -- 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, 'wksctl.tex', 'wksctl Documentation',
+     'wksctl development team', '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, 'wksctl', 'wksctl 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, 'wksctl', 'wksctl Documentation',
+     author, 'wksctl', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+def setup(app):
+    app.add_stylesheet('custom.css')

docs/development.md

@@ -33,3 +33,18 @@ docker push quay.io/wksctl/build:$(tools/image-tag)
 
 - Update `.circleci/config.yml` to use the newly pushed image.
 - Push this change, get it reviewed, and merge it to `master`.
+
+## Adding docs
+
+Docs live in the [`docs` directory](https://github.com/weaveworks/wksctl/tree/master/docs)
+and we use Markdown for everything. Every new commit will be published at
+<https://wksctl.readthedocs.io/en/latest/>.
+
+A few things to be aware of:
+
+- The landing page (`docs/index.rst`) is written in reStructuredText, because readthedocs uses sphinx for generating HTML/PDF/etc. Make sure your new doc is listed there - it's how the index is built. (`recommonmark` is used as the bridge between Markdown and reStructuredText).
+- Use `make serve-docs` to generate the docs locally and point a webbrowser to `localhost:8080` to check out if your changes worked out.
+- Links in the docs will be automatically tested.
+- Gotcha 1: links in markdown tables are problematic: <https://github.com/ryanfox/sphinx-markdown-tables/issues/18>
+- Gotcha 2: cross-referencing using anchors is problematic: <https://github.com/readthedocs/recommonmark/issues/8>
+- Gotcha 3: Make sure your use of headings, e.g. `#`, `##`, `###` makes sense. The table of contents will be a bit upset if you don't.

docs/get-started.md

@@ -42,4 +42,4 @@ These `--git` arguments are then used to set up and configure [flux](https://www
 
 We will rely on the user installing [fluxctl](https://docs.fluxcd.io/en/latest/references/fluxctl.html#installing-fluxctl) to interact with flux directly instead of trying to replicate the functionality within `wksctl`
 
-To see a more detailed example combining Wksctl, [GitOps](https://www.weave.works/technologies/gitops/), [Ignite](https://ignite.readthedocs.io/en/stable/) also know as FireKube see [Firekube](examples/footloose/README.md#firekube-gitops)
+To see a more detailed example combining Wksctl, [GitOps](https://www.weave.works/technologies/gitops/), [Ignite](https://ignite.readthedocs.io/en/stable/) also know as FireKube see [Firekube](https://github.com/weaveworks/wks-quickstart-firekube).

docs/index.rst

@@ -0,0 +1,20 @@
+.. Ignite documentation documentation master file, created by
+   sphinx-quickstart on Wed Jun 12 16:13:18 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+wksctl Documentation
+====================
+
+In this folder you can read more about how to use wksctl, and how it works:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Table of contents:
+
+   get-started
+   wks-and-footloose
+   wks-and-vagrant
+   wks-on-gce
+   faq
+   development

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx                 == 2.2.0
+sphinx_markdown_tables == 0.0.9
+recommonmark           == 0.6.0