Commit e78ddbd1 authored by Adriaan de Beer's avatar Adriaan de Beer
Browse files

Merge branch 'ST-256' into 'master'

ST-256 added some basic structure to the docs folder for automatic extraction of docstrings

See merge request ska-telescope/ska-skeleton!2
parents a863498a 5e70fde3
Loading
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -23,6 +23,7 @@ Sphinx = "*"
sphinx_rtd_theme = "*"
sphinx-autobuild = "*"
sphinxcontrib-websupport = "*"
recommonmark = "*"

[dev-packages]

+6 −1
Original line number Diff line number Diff line
@@ -66,8 +66,13 @@ Writing documentation
 --------------------
 * 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`
+2 −0
Original line number Diff line number Diff line
SHELL := /bin/bash
# Minimal makefile for Sphinx documentation
#

@@ -18,3 +19,4 @@ help:
# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/src/README.md

0 → 120000
+1 −0
Original line number Diff line number Diff line
../../README.md
 No newline at end of file
+8 −6
Original line number Diff line number Diff line
@@ -17,9 +17,9 @@
# 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 os
import sys
sys.path.insert(0, os.path.abspath('../..'))
import sphinx_rtd_theme

def setup(app):
@@ -36,6 +36,7 @@ def setup(app):
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
              'sphinx.ext.napoleon',
    'sphinx.ext.doctest',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
@@ -43,7 +44,8 @@ extensions = ['sphinx.ext.autodoc',
    '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']
@@ -51,8 +53,8 @@ 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'
Loading