Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-13 13:54:23 +00:00
Code Issues Actions Projects Releases Wiki Activity

remove php/sension extensions if building on rtd

Browse Source
This commit is contained in:
Julien Fastré 2015-05-01 23:10:04 +02:00
parent dad59e3b04
commit 66c33f7feb
1 changed files with 31 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
source/conf.py
View File

@ -16,18 +16,22 @@
import sys import sys
import os import os
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # 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('.'))
sys.path.append(os.path.abspath('./../_exts/sphinx-php')) if not on_rtd:
sys.path.append(os.path.abspath('./../_exts/sphinx-php'))
# adding PhpLexer # adding PhpLexer
from sphinx.highlighting import lexers from sphinx.highlighting import lexers
from pygments.lexers.compiled import CLexer from pygments.lexers.compiled import CLexer
from pygments.lexers.web import PhpLexer from pygments.lexers.web import PhpLexer
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
@ -40,11 +44,15 @@ from pygments.lexers.web import PhpLexer
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.todo', 'sphinx.ext.todo',
]
if not on_rtd:
extensions += [
'sensio.sphinx.refinclude', 'sensio.sphinx.refinclude',
'sensio.sphinx.configurationblock', 'sensio.sphinx.configurationblock',
'sensio.sphinx.phpcode', 'sensio.sphinx.phpcode',
'sensio.sphinx.bestpractice', 'sensio.sphinx.bestpractice',
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -110,21 +118,22 @@ pygments_style = 'sphinx'
#keep_warnings = False #keep_warnings = False
# -- Settings for symfony doc extension --------------------------------------------------- # -- Settings for symfony doc extension ---------------------------------------------------
# enable highlighting for PHP code not between ``<?php ... ?>`` by default if not on_rtd:
lexers['php'] = PhpLexer(startinline=True) # enable highlighting for PHP code not between ``<?php ... ?>`` by default
lexers['php-annotations'] = PhpLexer(startinline=True) lexers['php'] = PhpLexer(startinline=True)
lexers['php-standalone'] = PhpLexer(startinline=True) lexers['php-annotations'] = PhpLexer(startinline=True)
lexers['php-symfony'] = PhpLexer(startinline=True) lexers['php-standalone'] = PhpLexer(startinline=True)
lexers['varnish3'] = CLexer() lexers['php-symfony'] = PhpLexer(startinline=True)
lexers['varnish4'] = CLexer() lexers['varnish3'] = CLexer()
config_block = { lexers['varnish4'] = CLexer()
'varnish3': 'Varnish 3', config_block = {
'varnish4': 'Varnish 4' 'varnish3': 'Varnish 3',
} 'varnish4': 'Varnish 4'
# use PHP as the primary domain }
primary_domain = 'php' # use PHP as the primary domain
# set url for API links primary_domain = 'php'
api_url = 'http://api.symfony.com/master/%s' # set url for API links
api_url = 'http://api.symfony.com/master/%s'
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------
@ -360,8 +369,7 @@ epub_exclude_files = ['search.html']
# If false, no index is generated. # If false, no index is generated.
#epub_use_index = True #epub_use_index = True
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
#-- Options for todo #-- Options for todo