Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
L
lettuce
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
lettuce
Commits
1e097eaa
Commit
1e097eaa
authored
Jan 22, 2012
by
Benoit Bryon
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Introduced documentation conventions.
parent
daa8ea1b
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
136 additions
and
0 deletions
+136
-0
docs/dev/documentation.rst
+135
-0
docs/dev/index.rst
+1
-0
No files found.
docs/dev/documentation.rst
0 → 100644
View file @
1e097eaa
#################################
Contributing to the documentation
#################################
This documentation uses `Python-sphinx`_. It uses `reStructuredText`_ syntax.
***********
Conventions
***********
Language
========
The documentation is written in english.
Line length
===========
Limit all lines to a maximum of 79 characters.
Headings
========
Use the following symbols to create headings: ``# * = -``
As an example:
.. highlight:: rst
::
##################
H1: document title
##################
*********
Sample H2
*********
Sample H3
=========
Sample H4
---------
And sample text.
If you need more than H4, then consider creating a new document.
Code blocks
===========
Combine a "highlight" directive and a "::" to specify the programming language.
As an example:
.. highlight:: rst
::
.. highlight:: python
::
import this
.. warning::
"code-block" and "sourcecode" directives are not natively supported by
rst2html, which is used by Github's repository browser, i.e. those lines
won't appear on Github. Whereas "::" lines will.
Links and references
====================
On pages which are quite long, use links and references footnotes with the
"target-notes" directive. As an example:
.. highlight:: rst
::
#############
Some document
#############
Some text which includes links to `Example website`_ and many other links.
`Example website`_ can be referenced multiple times.
(... document content...)
And at the end of the document...
**********
References
**********
.. target-notes::
.. _`Example website`: http://www.example.com/
This :doc:`documentation` page uses this syntax.
*******
Recipes
*******
Install Sphinx
==============
`Python-sphinx`_ installation is covered in :doc:`/dev/install`.
In other cases, please refer to `Python-sphinx`_ documentation.
Export documentation to HTML
============================
.. highlight:: sh
::
cd docs/
make html
cd ..
HTML documentation is exported to docs/_build/html/.
**********
References
**********
.. target-notes::
.. _`Python-sphinx`: http://sphinx.pocoo.org/
.. _`reStructuredText`: http://docutils.sourceforge.net/rst.html
docs/dev/index.rst
View file @
1e097eaa
...
@@ -20,6 +20,7 @@ Table of contents
...
@@ -20,6 +20,7 @@ Table of contents
install
install
testing
testing
documentation
Keep in mind
Keep in mind
============
============
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment