github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1583 from ingwinlu/fix_doc_errors

Browse source 
Documentation fixes
This commit is contained in:
Justin Mayer 2015-01-08 09:36:26 -08:00
commit b72961f12d
3 changed files with 10 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.rst
View file

@ -1,5 +1,5 @@
Filing issues Filing issues
------------- =============
* Before you file an issue, try `asking for help`_ first. * Before you file an issue, try `asking for help`_ first.
* If determined to file an issue, first check for `existing issues`_, including * If determined to file an issue, first check for `existing issues`_, including
@ -9,7 +9,7 @@ Filing issues
.. _`existing issues`: https://github.com/getpelican/pelican/issues .. _`existing issues`: https://github.com/getpelican/pelican/issues
How to get help How to get help
--------------- ===============
Before you ask for help, please make sure you do the following: Before you ask for help, please make sure you do the following:
@ -66,7 +66,7 @@ Once the above preparation is ready, you can contact people willing to help via
Remember to include all the information you prepared. Remember to include all the information you prepared.
The #pelican IRC channel The #pelican IRC channel
........................ ------------------------
* Because of differing time zones, you may not get an immediate response to your * Because of differing time zones, you may not get an immediate response to your
question, but please be patient and stay logged into IRC — someone will almost question, but please be patient and stay logged into IRC — someone will almost
@ -81,7 +81,7 @@ The #pelican IRC channel
Contributing code Contributing code
----------------- =================
Before you submit a contribution, please ask whether it is desired so that you Before you submit a contribution, please ask whether it is desired so that you
don't spend a lot of time working on something that would be rejected for a don't spend a lot of time working on something that would be rejected for a
@ -89,7 +89,7 @@ known reason. Consider also whether your new feature might be better suited as
a plugin_ — you can `ask for help`_ to make that determination. a plugin_ — you can `ask for help`_ to make that determination.
Using Git and GitHub Using Git and GitHub
.................... --------------------
* `Create a new git branch`_ specific to your change (as opposed to making * `Create a new git branch`_ specific to your change (as opposed to making
your commits in the master branch). your commits in the master branch).
@ -116,7 +116,7 @@ Using Git and GitHub
turn your GitHub issue into a pull request containing your code. turn your GitHub issue into a pull request containing your code.
Contribution quality standards Contribution quality standards
.............................. ------------------------------
* Adhere to `PEP8 coding standards`_ whenever possible. This can be eased via * Adhere to `PEP8 coding standards`_ whenever possible. This can be eased via
the `pep8 <http://pypi.python.org/pypi/pep8>`_ or `flake8 the `pep8 <http://pypi.python.org/pypi/pep8>`_ or `flake8

4
docs/content.rst
View file

@ -502,8 +502,8 @@ If your articles should be automatically published as a draft (to not accidental
publish an article before it is finished) include the status in the ``DEFAULT_METADATA``:: publish an article before it is finished) include the status in the ``DEFAULT_METADATA``::
DEFAULT_METADATA = { DEFAULT_METADATA = {
'status': 'draft', 'status': 'draft',
} }
.. _W3C ISO 8601: http://www.w3.org/TR/NOTE-datetime .. _W3C ISO 8601: http://www.w3.org/TR/NOTE-datetime
.. _AsciiDoc: http://www.methods.co.nz/asciidoc/ .. _AsciiDoc: http://www.methods.co.nz/asciidoc/

1
docs/themes.rst
View file

@ -325,6 +325,7 @@ period A tuple of the form (`year`, `month`, `day`) that
=================== =================================================== =================== ===================================================
You can see an example of how to use `period` in the `"simple" theme You can see an example of how to use `period` in the `"simple" theme
period_archives.html template
<https://github.com/getpelican/pelican/blob/master/pelican/themes/simple/templates/period_archives.html>`_. <https://github.com/getpelican/pelican/blob/master/pelican/themes/simple/templates/period_archives.html>`_.