From 3baf4be91dc0cc46b77383583e0306e47ba0594c Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Sun, 23 Oct 2016 17:01:32 +0200 Subject: [PATCH] Fix links in docs and make first-level structure simpler to read --- README.rst | 36 ++++++++++++++++++------------------ docs/index.rst | 4 +--- docs/{ => tips}/faq.rst | 2 +- docs/tips/index.rst | 4 ++-- 4 files changed, 22 insertions(+), 24 deletions(-) rename docs/{ => tips}/faq.rst (92%) diff --git a/README.rst b/README.rst index 3ebc9701..6defa54c 100644 --- a/README.rst +++ b/README.rst @@ -4,11 +4,11 @@ django-wiki |Docs| |Build Status| |Coverage Status| |PyPi| |Dependency Status| .. |Docs| image:: https://readthedocs.org/projects/django-wiki/badge/?version=latest - :target: http://django-wiki.readthedocs.org/ + :target: http://django-wiki.readthedocs.io/ .. |Build Status| image:: https://travis-ci.org/django-wiki/django-wiki.png?branch=master :target: https://travis-ci.org/django-wiki/django-wiki -.. |Coverage Status| image:: http://codecov.io/github/django-wiki/django-wiki/coverage.svg?branch=master - :target: http://codecov.io/github/django-wiki/django-wiki?branch=master +.. |Coverage Status| image:: https://codecov.io/github/django-wiki/django-wiki/coverage.svg?branch=master + :target: https://codecov.io/github/django-wiki/django-wiki?branch=master .. |PyPi| image:: https://badge.fury.io/py/wiki.svg :target: https://pypi.python.org/pypi/wiki/ .. |Downloads| image:: https://img.shields.io/pypi/dm/wiki.svg @@ -30,7 +30,7 @@ Final release 0.1 is out. Please note that the only way to upgrade is from 0.0.2 - **0.0.24** added experimental Django 1.7 support. For upgrade instructions, please refer to the `Release -Notes `__ +Notes `__ News @@ -39,17 +39,17 @@ News October 13, 2016 ~~~~~~~~~~~~~~~~ -0.2b1 released: `Release notes `__ +0.2b1 released: `Release notes `__ June 19, 2016 ~~~~~~~~~~~~~ -0.1.2 released: `Release notes `__ +0.1.2 released: `Release notes `__ May 6, 2016 ~~~~~~~~~~~ -0.1.1 released: `Release notes `__ +0.1.1 released: `Release notes `__ January 25, 2016 @@ -109,7 +109,7 @@ Django-wiki has almost fully translated into 7 languages, apart from the default (English). But please help out in adding more languages! It's very easy, you don't even need to be a programmer. -https://www.transifex.com/projects/p/django-wiki/ +https://www.transifex.com/django-wiki/django-wiki/ Demo ---- @@ -117,7 +117,7 @@ Demo A demo running the latest ``master`` is available here, sign up for an account to see the notification system. -http://demo.django.wiki +https://demo.django.wiki Community --------- @@ -126,9 +126,9 @@ Please use our IRC or mailing list (google group) for getting in touch on development and support. Please do not email developers asking for personal support. -- #django-wiki on irc.freenode.net -- `django-wiki@googlegroups.com `__ -- `twitter:djangowiki `__ +- #django-wiki on irc.freenode.net +- `django-wiki@googlegroups.com `__ +- `twitter:djangowiki `__ *THIS IS A WORK IN PROGRE...* ----------------------------- @@ -211,7 +211,7 @@ Docs See the docs/ folder, or read them at: -http://django-wiki.readthedocs.org/en/latest/ +http://django-wiki.readthedocs.io/en/latest/ If you wish to add something, please ask in the google group or raise an issue if you're in doubt about whether something might change. @@ -220,7 +220,7 @@ Background ---------- Django-wiki is a rewrite of -`django-simplewiki `__, a +`django-simplewiki `__, a project from 2009 that aimed to be a base system for a wiki. It proposed that the user should customize the wiki by overwriting templates, but soon learned that the only customization that really took place was that @@ -239,7 +239,7 @@ Q&A ``pip install wiki``, it returned "No distributions at all found for wiki", so we had to make up for that! - **What markup language will you use?** - `Markdown `__. The markup + `Markdown `__. The markup renderer is not a pluggable part but has been internalized into core parts. Discussion should go here: https://github.com/django-wiki/django-wiki/issues/76 @@ -260,7 +260,7 @@ Please refer to current release to see exact version dependencies. And make note that Pillow needs to have certain build dependencies satisfied on your host system. -- `Django `__ +- `Django `__ - `Markdown `__ - `django-mptt `__ - `django-sekizai `__ @@ -282,7 +282,7 @@ models are changed. Acknowledgements ---------------- -- The people at `edX `__ & MIT for finding +- The people at `edX `__ & MIT for finding and supporting the project both financially and with ideas. - `django-cms `__ for venturing where no django app has gone before in terms of well-planned features @@ -299,6 +299,6 @@ Acknowledgements `bridger `__, `TomLottermann `__, `crazyzubr `__, and `everyone - else `__ + else `__ involved! diff --git a/docs/index.rst b/docs/index.rst index 9c66a48d..36513f0b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,13 +12,11 @@ A wiki for Django! :maxdepth: 2 installation + release_notes plugins customization settings tips/index - release_notes - faq - history .. include:: ../README.rst diff --git a/docs/faq.rst b/docs/tips/faq.rst similarity index 92% rename from docs/faq.rst rename to docs/tips/faq.rst index 7c2f7f77..dd1d7885 100644 --- a/docs/faq.rst +++ b/docs/tips/faq.rst @@ -23,7 +23,7 @@ Q: Why do I keep getting *"This slug conflicts with an existing URL."* ---------------------------------------------------------------------- A: When validating a slug, django-wiki will verify through -:doc:`settings`.``WIKI_CHECK_SLUG_URL_AVAILABLE`` (default: ``True``) that the URL is not +:doc:`../settings`.``WIKI_CHECK_SLUG_URL_AVAILABLE`` (default: ``True``) that the URL is not already occupied. So if you keep getting an error that the "slug" isn't available, it's diff --git a/docs/tips/index.rst b/docs/tips/index.rst index 5de55944..a73412c9 100644 --- a/docs/tips/index.rst +++ b/docs/tips/index.rst @@ -1,5 +1,5 @@ -Tips -==== +Tips & FAQ +========== .. toctree:: :caption: Tips index -- 2.45.2