Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overhaul the underlying structure of the documentation.
docs/index.rst
with information taken fromREADME.rst
,docs/installation.rst
anddocs/getting_started.rst
.README.rst
a link pointing todocs/index.rst
.docs/installation.rst
anddocs/getting_started.rst
.Why has this been done?
README.rst
a link means that there is now a single, authoritativesource for documentation. Formerly,
README.rst
and the variousdocs/*
files contained much duplicate information.
docs/installation.rst
anddocs/getting_started.rst
intodocs/index.rst
is simply sensible. The documents are short, and it isreasonable for their information to be contained in one page.
Update the makefile with a more robust, expansive and consistently named set of
rules.
&&
instead of;
for compoundcommands.
(
docs-doctest
) and the doctests are run when thetest
rule is evaulated.denote all rules defined in
docs/Makefile
.Fix broken doctests. It is now easy to test this because
make test
runs bothnormal unit tests and doctests.