diff options
| author | Rodney Ewing <ewing.rj@gmail.com> | 2013-07-09 12:57:57 -0700 |
|---|---|---|
| committer | Rodney Ewing <ewing.rj@gmail.com> | 2013-07-09 12:57:57 -0700 |
| commit | bd0ece0557d7ac4cbbf77617b125060b8c083892 (patch) | |
| tree | de932408182a148bbd7310eb9631ad31cbbcdcfd | |
| parent | 2c4cdd096f77772ae1f07a163e68c033c0fe1b2c (diff) | |
| download | mediagoblin-bd0ece0557d7ac4cbbf77617b125060b8c083892.tar.lz mediagoblin-bd0ece0557d7ac4cbbf77617b125060b8c083892.tar.xz mediagoblin-bd0ece0557d7ac4cbbf77617b125060b8c083892.zip | |
added basic_auth and openid docs to index and link them together
| -rw-r--r-- | docs/source/index.rst | 2 | ||||
| -rw-r--r-- | mediagoblin/plugins/basic_auth/README.rst | 6 | ||||
| -rw-r--r-- | mediagoblin/plugins/openid/README.rst | 12 |
3 files changed, 13 insertions, 7 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index c8a3f040..f6bc5561 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -59,6 +59,8 @@ Part 2: Core plugin documentation plugindocs/oauth plugindocs/trim_whitespace plugindocs/raven + plugindocs/basic_auth + plugindocs/openid Part 3: Plugin Writer's Guide diff --git a/mediagoblin/plugins/basic_auth/README.rst b/mediagoblin/plugins/basic_auth/README.rst index 65a7345e..82f247ed 100644 --- a/mediagoblin/plugins/basic_auth/README.rst +++ b/mediagoblin/plugins/basic_auth/README.rst @@ -1,5 +1,7 @@ +.. _basic_auth-chapter: + =================== - Basic_auth plugin + basic_auth plugin =================== The basic_auth plugin is enabled by default in mediagoblin.ini. This plugin @@ -8,7 +10,7 @@ provides basic username and password authentication for GNU Mediagoblin. This plugin can be enabled alongside :ref:`openid-chapter` and :ref:`persona-chapter`. -Set up the Basic_auth plugin +Set up the basic_auth plugin ============================ 1. Add the following to your MediaGoblin .ini file in the ``[plugins]`` section:: diff --git a/mediagoblin/plugins/openid/README.rst b/mediagoblin/plugins/openid/README.rst index e753b0f9..870a2b58 100644 --- a/mediagoblin/plugins/openid/README.rst +++ b/mediagoblin/plugins/openid/README.rst @@ -1,21 +1,23 @@ +.. _openid-chapter: + =================== - Openid plugin + openid plugin =================== -The Openid plugin allows user to login to your GNU Mediagoblin instance using +The openid plugin allows user to login to your GNU Mediagoblin instance using their openid url. This plugin can be enabled alongside :ref:`basic_auth-chapter` and :ref:`persona-chapter`. .. note:: - When :reg:`basic_auth-chapter` is enabled alongside this Openid plugin, and - a user creates an account using their Openid. If they would like to add a + When :ref:`basic_auth-chapter` is enabled alongside this openid plugin, and + a user creates an account using their openid. If they would like to add a password to their account, they can use the forgot password feature to do so. -Set up the Openid plugin +Set up the openid plugin ============================ 1. Install the ``python-openid`` package. |