Unverified Commit 0b01303a authored by Thom Wiggers's avatar Thom Wiggers 📐
Browse files

Include basic documentation site

parent b18e592a
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = Concrexit
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
activemembers package
=====================
.. automodule:: activemembers
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
activemembers.admin module
--------------------------
.. automodule:: activemembers.admin
:members:
:undoc-members:
:show-inheritance:
activemembers.apps module
-------------------------
.. automodule:: activemembers.apps
:members:
:undoc-members:
:show-inheritance:
activemembers.backends module
-----------------------------
.. automodule:: activemembers.backends
:members:
:undoc-members:
:show-inheritance:
activemembers.forms module
--------------------------
.. automodule:: activemembers.forms
:members:
:undoc-members:
:show-inheritance:
activemembers.models module
---------------------------
.. automodule:: activemembers.models
:members:
:undoc-members:
:show-inheritance:
activemembers.sitemaps module
-----------------------------
.. automodule:: activemembers.sitemaps
:members:
:undoc-members:
:show-inheritance:
activemembers.urls module
-------------------------
.. automodule:: activemembers.urls
:members:
:undoc-members:
:show-inheritance:
activemembers.views module
--------------------------
.. automodule:: activemembers.views
:members:
:undoc-members:
:show-inheritance:
announcements package
=====================
.. automodule:: announcements
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
announcements.admin module
--------------------------
.. automodule:: announcements.admin
:members:
:undoc-members:
:show-inheritance:
announcements.apps module
-------------------------
.. automodule:: announcements.apps
:members:
:undoc-members:
:show-inheritance:
announcements.context_processors module
---------------------------------------
.. automodule:: announcements.context_processors
:members:
:undoc-members:
:show-inheritance:
announcements.models module
---------------------------
.. automodule:: announcements.models
:members:
:undoc-members:
:show-inheritance:
announcements.urls module
-------------------------
.. automodule:: announcements.urls
:members:
:undoc-members:
:show-inheritance:
announcements.views module
--------------------------
.. automodule:: announcements.views
:members:
:undoc-members:
:show-inheritance:
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Concrexit documentation build configuration file, created by
# sphinx-quickstart on Fri Feb 3 16:04:30 2017.
#
# 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.
# 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.
#
import os
import sys
sys.path.insert(0, os.path.abspath('../website'))
import django
from django.conf import settings # noqa
from recommonmark.parser import CommonMarkParser # noqa
from thaliawebsite import settings as thalia_settings # noqa
# -- Initialise Django ----------------------------------------------------
settings.configure(thalia_settings)
django.setup()
# -- 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.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'Concrexit'
copyright = "2017, Technicie, Studievereniging Thalia"
author = "Technicie, Studievereniging Thalia"
# 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 = ''
# The full version, including alpha/beta/rc tags.
release = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- 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 = 'alabaster'
# 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 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']
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'Concrexitdoc'
# -- 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': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Concrexit.tex', 'Concrexit Documentation',
'Thom Wiggers, Luuk Scholten, Joost Rijneveld', 'manual'),
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'concrexit', 'Concrexit Documentation',
[author], 1)
]
# -- 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 = [
(master_doc, 'Concrexit', 'Concrexit Documentation',
author, 'Concrexit', "Thalia's website",
'Django Applications'),
]
# -- Options for autodoc --------------------------------------------------
# Default flags for autodoc, saves typing
autodoc_default_flags = ['members', 'undoc-members']
documents package
=================
.. automodule:: documents
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
documents.templatetags
Submodules
----------
documents.admin module
----------------------
.. automodule:: documents.admin
:members:
:undoc-members:
:show-inheritance:
documents.apps module
---------------------
.. automodule:: documents.apps
:members:
:undoc-members:
:show-inheritance:
documents.models module
-----------------------
.. automodule:: documents.models
:members:
:undoc-members:
:show-inheritance:
documents.sitemaps module
-------------------------
.. automodule:: documents.sitemaps
:members:
:undoc-members:
:show-inheritance:
documents.urls module
---------------------
.. automodule:: documents.urls
:members:
:undoc-members:
:show-inheritance:
documents.views module
----------------------
.. automodule:: documents.views
:members:
:undoc-members:
:show-inheritance:
documents.templatetags package
==============================
.. automodule:: documents.templatetags
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
documents.templatetags.filename module
--------------------------------------
.. automodule:: documents.templatetags.filename
:members:
:undoc-members:
:show-inheritance:
education package
=================
.. automodule:: education
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
education.admin module
----------------------
.. automodule:: education.admin
:members:
:undoc-members:
:show-inheritance:
education.apps module
---------------------
.. automodule:: education.apps
:members:
:undoc-members:
:show-inheritance:
education.forms module
----------------------
.. automodule:: education.forms
:members:
:undoc-members:
:show-inheritance:
education.models module
-----------------------
.. automodule:: education.models
:members:
:undoc-members:
:show-inheritance:
education.sitemaps module
-------------------------
.. automodule:: education.sitemaps
:members:
:undoc-members:
:show-inheritance:
education.urls module
---------------------
.. automodule:: education.urls
:members:
:undoc-members:
:show-inheritance:
education.views module
----------------------
.. automodule:: education.views
:members:
:undoc-members:
:show-inheritance:
events.api package
==================
.. automodule:: events.api
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
events.api.serializers module
-----------------------------
.. automodule:: events.api.serializers
:members:
:undoc-members:
:show-inheritance:
events.api.urls module
----------------------
.. automodule:: events.api.urls
:members:
:undoc-members:
:show-inheritance:
events.api.viewsets module
--------------------------
.. automodule:: events.api.viewsets
:members:
:undoc-members:
:show-inheritance:
events package
==============
.. automodule:: events
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
events.api
Submodules
----------
events.admin module
-------------------
.. automodule:: events.admin
:members:
:undoc-members:
:show-inheritance:
events.apps module
------------------
.. automodule:: events.apps
:members:
:undoc-members:
:show-inheritance:
events.feeds module
-------------------
.. automodule:: events.feeds
:members:
:undoc-members:
:show-inheritance:
events.forms module
-------------------
.. automodule:: events.forms
:members:
:undoc-members:
:show-inheritance:
events.models module
--------------------
.. automodule:: events.models
:members:
:undoc-members:
:show-inheritance:
events.sitemaps module
----------------------
.. automodule:: events.sitemaps
:members:
:undoc-members:
:show-inheritance:
events.urls module
------------------
.. automodule:: events.urls
:members:
:undoc-members:
:show-inheritance:
events.views module
-------------------
.. automodule:: events.views
:members:
:undoc-members:
:show-inheritance:
#!/bin/sh
if [ ! -f "./index.rst" ]; then
>&2 echo "Run me from the docs/ folder!"
exit 1
fi
sphinx-apidoc -M -f -o docs ../website ../website/*/migrations ../website/*/tests* ../website/manage.py
Concrexit, Thalia's website
===========================
.. toctree::
:maxdepth: 2
:caption: Contents:
readme
modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
mailinglists package
====================
.. automodule:: mailinglists
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
mailinglists.admin module
-------------------------