mirror of
https://github.com/vale981/ablog
synced 2025-03-05 09:11:38 -05:00
150 lines
3.9 KiB
Python
150 lines
3.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
import os
|
|
import sys
|
|
|
|
|
|
import alabaster
|
|
import ablog
|
|
|
|
ablog_builder = 'dirhtml'
|
|
ablog_website = '_website'
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.doctest',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.ifconfig',
|
|
'sphinx.ext.extlinks',
|
|
#'IPython.sphinxext.ipython_directive',
|
|
#'IPython.sphinxext.ipython_console_highlighting',
|
|
'alabaster',
|
|
'ablog'
|
|
]
|
|
|
|
#language = 'de'
|
|
#language = 'tr'
|
|
# PROJECT
|
|
|
|
version = release = ablog.__version__
|
|
project = u'ABlog'
|
|
copyright = u'2014-2015, ABlog Team'
|
|
master_doc = 'index'
|
|
source_suffix = '.rst'
|
|
exclude_patterns = ['_build']
|
|
|
|
|
|
# HTML OUTPUT
|
|
|
|
html_title = "ABlog"
|
|
html_static_path = ['_static']
|
|
html_use_index = True
|
|
html_domain_indices = False
|
|
html_show_sourcelink = True
|
|
html_favicon = '_static/ablog.ico'
|
|
|
|
# ABLOG
|
|
|
|
templates_path = [ablog.get_html_templates_path()]
|
|
|
|
blog_title = 'ABlog'
|
|
blog_baseurl = 'http://ablog.readthedocs.org'
|
|
blog_locations = {
|
|
'Pittsburgh': ('Pittsburgh, PA', 'http://en.wikipedia.org/wiki/Pittsburgh'),
|
|
'SF': ('San Francisco, CA', 'http://en.wikipedia.org/wiki/San_Francisco'),
|
|
'Denizli': ('Denizli, Turkey', 'http://en.wikipedia.org/wiki/Denizli'),
|
|
}
|
|
blog_languages = {
|
|
'en': ('English', None),
|
|
}
|
|
blog_default_language = 'en'
|
|
blog_authors = {
|
|
'Ahmet': ('Ahmet Bakan', 'http://ahmetbakan.com'),
|
|
'Luc': ('Luc Saffre', 'http://saffre-rumma.net/luc/'),
|
|
'Mehmet': (u'Mehmet Gerçeker', 'https://github.com/mehmetg'),
|
|
}
|
|
blog_feed_archives = True
|
|
blog_feed_fulltext = True
|
|
blog_feed_length = None
|
|
disqus_shortname = 'ablogforsphinx'
|
|
disqus_pages = True
|
|
fontawesome_css_file = 'css/font-awesome.css'
|
|
|
|
# blog_feed_titles = False
|
|
# blog_archive_titles = False
|
|
# post_auto_excerpt = 1
|
|
|
|
# THEME
|
|
|
|
html_style = 'alabaster.css'
|
|
html_theme = 'alabaster'
|
|
html_sidebars = {
|
|
'**': ['about.html',
|
|
'postcard.html', 'recentposts.html',
|
|
'tagcloud.html', 'categories.html',
|
|
'archives.html',
|
|
'searchbox.html']
|
|
}
|
|
html_theme_path = [alabaster.get_path()]
|
|
html_theme_options = {
|
|
'travis_button': True,
|
|
'github_user': 'abakan',
|
|
'github_repo': 'ablog',
|
|
'description': 'ABlog for blogging with Sphinx',
|
|
'logo': 'ablog.png',
|
|
}
|
|
|
|
# SPHINX
|
|
|
|
intersphinx_mapping = {
|
|
'python': ('http://docs.python.org/', None),
|
|
'sphinx': ('http://sphinx-doc.org/', None)
|
|
}
|
|
extlinks = {
|
|
'wiki': ('http://en.wikipedia.org/wiki/%s', ''),
|
|
'issue': ('https://github.com/abakan/ablog/issues/%s', 'issue '),
|
|
'pull': ('https://github.com/abakan/ablog/pull/%s', 'pull request '),
|
|
}
|
|
|
|
rst_epilog = '''
|
|
.. _Sphinx: http://sphinx-doc.org/
|
|
.. _Python: http://python.org
|
|
.. _Disqus: http://disqus.com/
|
|
.. _GitHub: https://github.com/abakan/ablog
|
|
.. _PyPI: https://pypi.python.org/pypi/ablog
|
|
.. _Read The Docs: https://readthedocs.org/
|
|
.. _Alabaster: https://github.com/bitprophet/alabaster
|
|
'''
|
|
|
|
import re
|
|
from sphinx import addnodes
|
|
|
|
|
|
event_sig_re = re.compile(r'([a-zA-Z-]+)\s*\((.*)\)')
|
|
|
|
def parse_event(env, sig, signode):
|
|
m = event_sig_re.match(sig)
|
|
if not m:
|
|
signode += addnodes.desc_name(sig, sig)
|
|
return sig
|
|
name, args = m.groups()
|
|
signode += addnodes.desc_name(name, name)
|
|
plist = addnodes.desc_parameterlist()
|
|
for arg in args.split(','):
|
|
arg = arg.strip()
|
|
plist += addnodes.desc_parameter(arg, arg)
|
|
signode += plist
|
|
return name
|
|
|
|
|
|
def setup(app):
|
|
from sphinx.ext.autodoc import cut_lines
|
|
from sphinx.util.docfields import GroupedField
|
|
app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
|
|
app.add_object_type('confval', 'confval',
|
|
objname='configuration value',
|
|
indextemplate='pair: %s; configuration value')
|
|
fdesc = GroupedField('parameter', label='Parameters',
|
|
names=['param'], can_collapse=True)
|
|
app.add_object_type('event', 'event', 'pair: %s; event', parse_event,
|
|
doc_field_types=[fdesc])
|