130 lines
4.9 KiB
Python
130 lines
4.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
#pylint: disable=C0103
|
|
#pylint: disable=W0622
|
|
#pylint: disable=W0212
|
|
#pylint: disable=W0613
|
|
|
|
import sys, os
|
|
|
|
from docs.shared.conf import *
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path.append('source/_templates')
|
|
|
|
|
|
# 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.append('source/_static')
|
|
|
|
|
|
|
|
import sys
|
|
import 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('.'))
|
|
sys.path.insert(0, os.path.abspath('../..')) # mitx folder
|
|
|
|
# django configuration - careful here
|
|
os.environ['DJANGO_SETTINGS_MODULE'] = 'lms.envs.test'
|
|
|
|
|
|
# -- General configuration -----------------------------------------------------
|
|
|
|
# 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.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage',
|
|
'sphinx.ext.pngmath', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
exclude_patterns = ['build']
|
|
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'edXDocs'
|
|
|
|
|
|
# from http://djangosnippets.org/snippets/2533/
|
|
# autogenerate models definitions
|
|
|
|
import inspect
|
|
from django.utils.html import strip_tags
|
|
from django.utils.encoding import force_unicode
|
|
|
|
|
|
def process_docstring(app, what, name, obj, options, lines):
|
|
"""Autodoc django models"""
|
|
|
|
# This causes import errors if left outside the function
|
|
from django.db import models
|
|
|
|
# If you want extract docs from django forms:
|
|
# from django import forms
|
|
# from django.forms.models import BaseInlineFormSet
|
|
|
|
# Only look at objects that inherit from Django's base MODEL class
|
|
if inspect.isclass(obj) and issubclass(obj, models.Model):
|
|
# Grab the field list from the meta class
|
|
fields = obj._meta._fields()
|
|
|
|
for field in fields:
|
|
# Decode and strip any html out of the field's help text
|
|
help_text = strip_tags(force_unicode(field.help_text))
|
|
|
|
# Decode and capitalize the verbose name, for use if there isn't
|
|
# any help text
|
|
verbose_name = force_unicode(field.verbose_name).capitalize()
|
|
|
|
if help_text:
|
|
# Add the model field to the end of the docstring as a param
|
|
# using the help text as the description
|
|
lines.append(u':param %s: %s' % (field.attname, help_text))
|
|
else:
|
|
# Add the model field to the end of the docstring as a param
|
|
# using the verbose name as the description
|
|
lines.append(u':param %s: %s' % (field.attname, verbose_name))
|
|
|
|
# Add the field's type to the docstring
|
|
lines.append(u':type %s: %s' % (field.attname, type(field).__name__))
|
|
# Only look at objects that inherit from Django's base FORM class
|
|
# elif (inspect.isclass(obj) and issubclass(obj, forms.ModelForm) or issubclass(obj, forms.ModelForm) or issubclass(obj, BaseInlineFormSet)):
|
|
# pass
|
|
# # Grab the field list from the meta class
|
|
# import ipdb; ipdb.set_trace()
|
|
# fields = obj._meta._fields()
|
|
# import ipdb; ipdb.set_trace()
|
|
# for field in fields:
|
|
# import ipdb; ipdb.set_trace()
|
|
# # Decode and strip any html out of the field's help text
|
|
# help_text = strip_tags(force_unicode(field.help_text))
|
|
|
|
# # Decode and capitalize the verbose name, for use if there isn't
|
|
# # any help text
|
|
# verbose_name = force_unicode(field.verbose_name).capitalize()
|
|
|
|
# if help_text:
|
|
# # Add the model field to the end of the docstring as a param
|
|
# # using the help text as the description
|
|
# lines.append(u':param %s: %s' % (field.attname, help_text))
|
|
# else:
|
|
# # Add the model field to the end of the docstring as a param
|
|
# # using the verbose name as the description
|
|
# lines.append(u':param %s: %s' % (field.attname, verbose_name))
|
|
|
|
# # Add the field's type to the docstring
|
|
# lines.append(u':type %s: %s' % (field.attname, type(field).__name__))
|
|
# Return the extended docstring
|
|
return lines
|
|
|
|
|
|
def setup(app):
|
|
"""Setup docsting processors"""
|
|
#Register the docstring processor with sphinx
|
|
app.connect('autodoc-process-docstring', process_docstring)
|