Include README.md as optional documentation of the project

sphinx_rtd_theme = "*"

sphinx-autobuild = "*"

sphinxcontrib-websupport = "*"

recommonmark = "*"

[dev-packages]

 --------------------

 * The documentation generator for this project is derived from SKA's [SKA Developer Portal repository](https://github.com/ska-telescope/developer.skatelescope.org)

 * The documentation can be edited under `./docs/src`

 * If you want to include only your README.md file, create a symbolic link inside the `./docs/src` directory if the existing one does not work:

 ```bash

$ cd docs/src

$ ln -s ../../README.md README.md

```

 * In order to build the documentation for this specific project, execute the following under `./docs`:

 ```bash

> make html

$ make html

```

* The documentation can then be consulted by opening the file `./docs/build/html/index.html`

SHELL := /bin/bash

# Minimal makefile for Sphinx documentation

#

# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

%: Makefile

	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

../../README.md

 No newline at end of file

    'sphinx.ext.mathjax',

    'sphinx.ext.ifconfig',

    'sphinx.ext.viewcode',

    'sphinx.ext.githubpages']

    'sphinx.ext.githubpages',

              'recommonmark']

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

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

# source_suffix = '.rst'

# The master toctree document.

master_doc = 'index'