summaryrefslogtreecommitdiff
path: root/development/Sphinx/slack-desc
diff options
context:
space:
mode:
Diffstat (limited to 'development/Sphinx/slack-desc')
-rw-r--r--development/Sphinx/slack-desc19
1 files changed, 19 insertions, 0 deletions
diff --git a/development/Sphinx/slack-desc b/development/Sphinx/slack-desc
new file mode 100644
index 0000000000..cc6a8f35e6
--- /dev/null
+++ b/development/Sphinx/slack-desc
@@ -0,0 +1,19 @@
+# HOW TO EDIT THIS FILE:
+# The "handy ruler" below makes it easier to edit a package description. Line
+# up the first '|' above the ':' following the base package name, and the '|'
+# on the right side marks the last column you can put a character in. You must
+# make exactly 11 lines for the formatting to be correct. It's also
+# customary to leave one space after the ':'.
+
+ |-----handy-ruler------------------------------------------------------|
+Sphinx: Sphinx (Documentation generator)
+Sphinx:
+Sphinx: Sphinx is a tool that translates a set of reStructuredText source
+Sphinx: files into various output formats, automatically producing
+Sphinx: cross-references, indices etc. The focus is on hand-written
+Sphinx: documentation, rather than auto-generated API docs. Though there is
+Sphinx: support for that kind of docs as well (which is intended to be
+Sphinx: freely mixed with hand-written content). If you need pure API docs
+Sphinx: have a look at Epydoc, which also understands reST.
+Sphinx:
+Sphinx: