Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul docs and makefile #41

Merged
merged 1 commit into from
Sep 22, 2014
Merged

Overhaul docs and makefile #41

merged 1 commit into from
Sep 22, 2014

Conversation

Ichimonji10
Copy link
Contributor

Overhaul the underlying structure of the documentation.

  • Expand docs/index.rst with information taken from README.rst,
    docs/installation.rst and docs/getting_started.rst.
  • Make README.rst a link pointing to docs/index.rst.
  • Drop docs/installation.rst and docs/getting_started.rst.

Why has this been done?

  • Making README.rst a link means that there is now a single, authoritative
    source for documentation. Formerly, README.rst and the various docs/*
    files contained much duplicate information.
  • Merging docs/installation.rst and docs/getting_started.rst into
    docs/index.rst is simply sensible. The documents are short, and it is
    reasonable for their information to be contained in one page.

Update the makefile with a more robust, expansive and consistently named set of
rules.

  • The rules are more robust because they use && instead of ; for compound
    commands.
  • The rules are more expansive because a new rule has been added
    (docs-doctest) and the doctests are run when the test rule is evaulated.
  • The rules are more consistently named because the prefix "docs-" is used to
    denote all rules defined in docs/Makefile.

Fix broken doctests. It is now easy to test this because make test runs both
normal unit tests and doctests.

Overhaul the underlying structure of the documentation.

* Expand `docs/index.rst` with information taken from `README.rst`,
  `docs/installation.rst` and `docs/getting_started.rst`.
* Make `README.rst` a link pointing to `docs/index.rst`.
* Drop `docs/installation.rst` and `docs/getting_started.rst`.

Why has this been done?

* Making `README.rst` a link means that there is now a single, authoritative
  source for documentation. Formerly, `README.rst` and the various `docs/*`
  files contained much duplicate information.
* Merging `docs/installation.rst` and `docs/getting_started.rst` into
  `docs/index.rst` is simply sensible. The documents are short, and it is
  reasonable for their information to be contained in one page.

Update the makefile with a more robust, expansive and consistently named set of
rules.

* The rules are more robust because they use `&&` instead of `;` for compound
  commands.
* The rules are more expansive because a new rule has been added
  (`docs-doctest`) and the doctests are run when the `test` rule is evaulated.
* The rules are more consistently named because the prefix "docs-" is used to
  denote all rules defined in `docs/Makefile`.

Fix broken doctests. It is now easy to test this because `make test` runs both
normal unit tests and doctests.
@coveralls
Copy link

Coverage Status

Coverage remained the same when pulling 0bd0119 on Ichimonji10:docs-makefile into bf2cd25 on omaciel:master.

@omaciel
Copy link
Owner

omaciel commented Sep 22, 2014

ACK

omaciel added a commit that referenced this pull request Sep 22, 2014
@omaciel omaciel merged commit e8b1591 into omaciel:master Sep 22, 2014
@Ichimonji10 Ichimonji10 deleted the docs-makefile branch September 22, 2014 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants