Skip to content
This repository was archived by the owner on Apr 25, 2023. It is now read-only.

Proof-read documentation #4

Open
ntoll opened this issue Jan 24, 2013 · 0 comments
Open

Proof-read documentation #4

ntoll opened this issue Jan 24, 2013 · 0 comments
Assignees
Milestone

Comments

@ntoll
Copy link
Owner

ntoll commented Jan 24, 2013

One of my aims with Drogulus is to have great documentation from the start. Furthermore, writing coherent and useful documentation should be a core part of the development process and I want to ensure a strong and unambiguous precedent is set. I've been reading up on Don Knuth's "literate programming" (viz. http://en.wikipedia.org/wiki/Literate_programming), would like to borrow from these conventions and make use of the existing Sphinx document-creation suite (viz. http://sphinx-doc.org/).

To fulfil this ticket three requirements must be met:

  • It must be obvious how to build the documentation (something in the README.rst file and an updated requirements.txt file).
  • The documentation (in the doc directory) should build correctly and be complete (i.e. all appropriately formatted documentation in the source code should find its way in to the generated documentation).
  • The content of the documentation should be well organised, correct and make sense.

The first two items are technical and testable, the final item is more a matter of taste. However, I feel that the third item is the most important given that I am close to the code and it all makes sense to me. It would be wonderful to get feedback.

N.B. Most of the non-source derived documentation is in an untidy "brain-dump" state and will be improved soon. This will include a getting started guide for both users and developers.

@ntoll ntoll added this to the 0.0.1.alpha.1 milestone Aug 4, 2015
@ntoll ntoll self-assigned this Aug 4, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant