From e8b51a396d27271aa8b8d06724a21dbe2f0ac895 Mon Sep 17 00:00:00 2001 From: Joseph Spiros Date: Wed, 1 Feb 2012 15:16:23 -0500 Subject: [PATCH] Fixed a few bugs with the documentation, and links to the documentation from the README. Sphinx can now build the documentation reliably due to conf.py explicitly adding the docs directory to the path. Added a link to the Bitbucket mirror, extending the set currently consisting of GitHub and Gitorious. --- README | 2 +- README.markdown | 2 +- docs/conf.py | 1 + docs/contributing.rst | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README b/README index 630ea76..19977cd 100644 --- a/README +++ b/README @@ -16,4 +16,4 @@ After installing philo and mptt on your PYTHONPATH, make sure to complete the fo 3. Include 'philo.urls' somewhere in your urls.py file. 4. Optionally add a root node to your current Site. -Philo should be ready to go! All that's left is to learn more and contribute . +Philo should be ready to go! All that's left is to learn more and contribute . diff --git a/README.markdown b/README.markdown index 77ebb65..2653f52 100644 --- a/README.markdown +++ b/README.markdown @@ -17,4 +17,4 @@ After installing philo and mptt on your PYTHONPATH, make sure to complete the fo 3. Include 'philo.urls' somewhere in your urls.py file. 4. Optionally add a root node to your current Site. -Philo should be ready to go! All that's left is to [learn more](http://docs.philocms.org/) and [contribute](http://docs.philocms.org/en/latest/contribute.html). +Philo should be ready to go! All that's left is to [learn more](http://docs.philocms.org/) and [contribute](http://docs.philocms.org/en/latest/contributing.html). diff --git a/docs/conf.py b/docs/conf.py index d41e6e0..b1329ba 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,6 +16,7 @@ import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.append(os.path.abspath(os.path.dirname(__file__))) sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext"))) sys.path.append(os.path.abspath(os.path.dirname(os.path.dirname(__file__)))) diff --git a/docs/contributing.rst b/docs/contributing.rst index 4c9fb7d..85fc311 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -4,7 +4,7 @@ Contributing to Philo So you want to contribute to Philo? That's great! Here's some ways you can get started: * **Report bugs and request features** using the issue tracker at the `project site `_. -* **Contribute code** using `git `_. You can fork philo's repository either on `GitHub `_ or `Gitorious `_. If you are contributing to Philo, you will need to submit a :ref:`Contributor License Agreement `. +* **Contribute code** using `git `_. You can fork philo's repository on `GitHub `_, `Gitorious `_, or `Bitbucket `_. If you are contributing to Philo, you will need to submit a :ref:`Contributor License Agreement `. * **Join the discussion** on IRC at `irc://irc.oftc.net/#philo `_ if you have any questions or suggestions or just want to chat about the project. You can also keep in touch using the project mailing lists: `philo@ithinksw.org `_ and `philo-devel@ithinksw.org `_. -- 2.20.1