From b2488b5ecfaceb7a1eb9a6a179bf029cc11cfd09 Mon Sep 17 00:00:00 2001 From: Mitar Date: Mon, 4 Jun 2012 15:51:30 +0200 Subject: [PATCH] Added documentation. --- README.rst | 3 - docs/Makefile | 130 +++++++++++++++++++++++++ docs/conf.py | 253 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 144 ++++++++++++++++++++++++++++ 4 files changed, 527 insertions(+), 3 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/README.rst b/README.rst index f31e752..d1aa388 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,3 @@ -Trac wiki engine integration with Django CMS -============================================ - A plugin for `cmsplugin-markup`_ which adds Trac_ wiki engine support to Django CMS. It enables you to have content in Trac wiki syntax. It also supports Trac macros and it is also integrated with `django-filer`_ and `cmsplugin-blog`_. diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..f737ea0 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,130 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nodewatcher.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nodewatcher.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/nodewatcher" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/nodewatcher" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + make -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..fbc91b3 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,253 @@ +# -*- coding: utf-8 -*- +# +# cmsplugin-markup-tracwiki documentation build configuration file, created by +# sphinx-quickstart on Tue Feb 28 22:56:01 2012. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +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.insert(0, os.path.abspath('.')) + +import imp +module_setup = imp.load_source('module_setup', os.path.join(os.path.dirname(__file__), '..', 'setup.py')) +VERSION = module_setup.VERSION + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.intersphinx'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'cmsplugin-markup-tracwiki' +copyright = u'2012, wlan slovenija' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = VERSION +# The full version, including alpha/beta/rc tags. +release = VERSION + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'nature' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +html_show_sphinx = False + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +html_show_copyright = False + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'cmspluginmarkuptracwikidoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'cmspluginmarkuptracwiki.tex', u'cmsplugin-markup-tracwiki Documentation', + u'wlan slovenija', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'cmsplugin-markup-tracwiki', u'cmsplugin-markup-tracwiki Documentation', + [u'wlan slovenija'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'cmspluginmarkuptracwiki', u'cmsplugin-markup-tracwiki Documentation', + u'wlan slovenija', 'cmsplugin-markup-tracwiki', 'Trac wiki engine support for Django CMS.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + 'python': ('http://python.readthedocs.org/en/latest/', None), + 'django': ('http://django.readthedocs.org/en/latest/', None), +} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..bb24ea5 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,144 @@ +cmsplugin-markup-tracwiki's documentation +========================================= + +A plugin for `cmsplugin-markup`_ which adds Trac_ wiki engine support to Django +CMS. It enables you to have content in Trac wiki syntax. It also supports Trac +macros and it is also integrated with `django-filer`_ and `cmsplugin-blog`_. +You can easily (with GUI) add files and images to the content, or any other +text-enabled plugin content. + +.. _cmsplugin-markup: https://bitbucket.org/mitar/cmsplugin-markup +.. _Trac: http://trac.edgewall.org/ +.. _django-filer: https://github.com/stefanfoulis/django-filer +.. _cmsplugin-blog: https://github.com/fivethreeo/cmsplugin-blog + +Installation +------------ + +You should just install it somewhere Django can find it, add +``cmsplugin_markup`` to ``INSTALLED_APPS`` and add +``cmsplugin_markup_tracwiki`` to ``CMS_MARKUP_OPTIONS``. You should of course +also have Trac installed and an otherwise working Django CMS installation. +Plugin was tested with 0.12 Trac version. + +You should include in your ``urls.py`` plugins URLs, for example:: + + urlpatterns = patterns('', + # ... + url(r'^', include('cmsplugin_markup.urls')), + +Wiki Syntax +----------- + +You should check out the `wiki syntax documentation +`_ for introducion to Trac wiki +engine. As this integration uses this engine directly, everything supported +there is also available in Django CMS. (If something is missing or not working +properly, please let me know.) + +There are some differences: + +* not all known wiki macros are enabled by default (like ``Image``) as they are + not needed or reasonable +* wiki namespace is not available (as there is no wiki) + +There are three new namespaces available: + +* ``cms`` to access Django CMS pages (using optional reverse ID to identify + them) or anything else in Django namespace, accessible by `reverse` +* ``filer`` to access django-filer files (using original filename, current + name, SHA-1 hash or stored file path) +* ``blog`` to access cmsplugin-blog entries (using slug, and optionally + language code) + +Examples:: + + [cms:page-with-name Page with reverse ID name] + [cms:admin:index Admin main page] + [filer:original-filename.png File] + [blog:my-first-entry First blog entry] + [blog:en:my-first-entry First blog entry in English] + +There are two macros which bridges the gap to Django template tags: + +- ``url`` macro which wrapps Django's ``url`` template tag +- ``now`` macro which wrapps Django's ``now`` template tag (an example of a dynamic macro) + +There is a special ``CMSPlugin`` macro which renders a Django CMS plugin which +was inserted into the wiki markup. Probably you should not use it manually. + +Additional macros or other features can be added on request. Or you can just +clone the repository and implement them yourself and send me a pull request. + +Settings +-------- + +There are the following Django settings. + +``CMS_MARKUP_TRAC_INTERTRAC`` configures Trac's `InterTrac +`_ links. For example:: + + CMS_MARKUP_TRAC_INTERTRAC = { + 'trac': { + 'TITLE': 'The Trac Project', + 'URL': 'http://trac.edgewall.org', + }, + } + +allows you to link to the ticket #1234 in Trac's official installation with +``[trac:ticket:1234 #1234]``. + +Similar ``CMS_MARKUP_TRAC_INTERWIKI`` allows general `InterWiki +`_ links:: + + CMS_MARKUP_TRAC_INTERWIKI = { + 'wikipedia': { + 'TITLE': 'Wikipedia', + 'URL': 'http://en.wikipedia.org/wiki/', + }, + } + +``CMS_MARKUP_TRAC_COMPONENTS`` configures which additional Trac plugins +(components) should be enabled. They should of course be in Python path. And +probably defined fully, like:: + + CMS_MARKUP_TRAC_COMPONENTS = ( + 'tracdashessyntax.plugin.DashesSyntaxPlugin', + 'footnotemacro.macro.FootNoteMacro', + 'mathjax.api.MathJaxPlugin', + 'tracmath.tracmath.TracMathPlugin', + ) + +``CMS_MARKUP_TRAC_CONFIGURATION`` allows definining any additional Trac +configuration options, like:: + + CMS_MARKUP_TRAC_CONFIGURATION = { + 'tracmath': { + 'cache_dir': os.path.join(PROJECT_PATH, 'tracwiki', 'cache'), + } + } + +And ``CMS_MARKUP_TRAC_TEMPLATES_DIR`` specifies directory with Trac templates. +Example:: + + CMS_MARKUP_TRAC_TEMPLATES_DIR = os.path.join(PROJECT_PATH, 'tracwiki', 'templates') + +``CMS_MARKUP_TRAC_HEADING_OFFSET`` configures the heading offset when rendering +wiki syntax. Useful when you are including wiki content inside some other +content with existing headings. Default is 1 which means that ``= Heading =`` +becomes ``

Heading

``. Setting it to 0 disables this feature. +(env_cms)root@implicator:/srv/cms/sources/cmsplugin-markup-tracwiki/docs# + +Source Code and Issue Tracker +----------------------------- + +For development Bitbucket_ is used, so source code and issue tracker is found +there_. + +.. _GitHub: https://bitbucket.org/ +.. _there: https://bitbucket.org/mitar/cmsplugin-markup-tracwiki + +Indices and tables +================== +* :ref:`genindex` +* :ref:`search`