Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs build on Sphinx 2.0.0 #3480

Merged
merged 6 commits into from
Mar 30, 2019
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -338,3 +338,5 @@ Contributors
- Alexandre Yukio Harano, 2018/10/05

- Arijit Basu, 2019/02/19

- Theron Luhn, 2019/03/30
38 changes: 19 additions & 19 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

from docutils import nodes
from docutils import utils
from docutils.parsers.rst import Directive


def raw(*arg):
Expand Down Expand Up @@ -326,7 +327,6 @@ def nothing(*arg):

latex_elements = {
'preamble': _PREAMBLE,
'date': '',
'releasename': 'Version',
'title': r'The Pyramid Web Framework',
# 'pointsize':'12pt', # uncomment for 12pt version
Expand All @@ -345,25 +345,25 @@ def nothing(*arg):
#subparagraph 5


def frontmatter(name, arguments, options, content, lineno,
content_offset, block_text, state, state_machine):
return [nodes.raw(
'',
format='latex')]
class FrontMatter(Directive):
def run(self):
return [nodes.raw(
'',
format='latex')]


def mainmatter(name, arguments, options, content, lineno,
content_offset, block_text, state, state_machine):
return [nodes.raw(
'',
format='latex')]
class MainMatter(Directive):
def run(self):
return [nodes.raw(
'',
format='latex')]


def backmatter(name, arguments, options, content, lineno,
content_offset, block_text, state, state_machine):
return [nodes.raw(
'',
format='latex')]
class BackMatter(Directive):
def run(self):
return [nodes.raw(
'',
format='latex')]


def app_role(role, rawtext, text, lineno, inliner, options={}, content=[]):
Expand All @@ -378,9 +378,9 @@ def app_role(role, rawtext, text, lineno, inliner, options={}, content=[]):

def setup(app):
app.add_role('app', app_role)
app.add_directive('frontmatter', frontmatter, 1, (0, 0, 0))
app.add_directive('mainmatter', mainmatter, 1, (0, 0, 0))
app.add_directive('backmatter', backmatter, 1, (0, 0, 0))
app.add_directive('frontmatter', FrontMatter, 1, (0, 0, 0))
app.add_directive('mainmatter', MainMatter, 1, (0, 0, 0))
app.add_directive('backmatter', BackMatter, 1, (0, 0, 0))
app.connect('autodoc-process-signature', resig)


Expand Down
8 changes: 2 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,11 +152,9 @@ Comprehensive reference material for every public API exposed by
:app:`Pyramid`:

.. toctree::
:maxdepth: 1
:glob:
:maxdepth: 2

api/index
api/*


``p*`` Scripts Documentation
Expand All @@ -165,11 +163,9 @@ Comprehensive reference material for every public API exposed by
``p*`` scripts included with :app:`Pyramid`.

.. toctree::
:maxdepth: 1
:glob:
:maxdepth: 2

pscripts/index
pscripts/*


Change History
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def readfile(name):


docs_extras = [
'Sphinx >= 1.8.1', # Unicode characters in tree diagrams
'Sphinx == 1.8.5', # Current version for Read the Docs
'docutils',
'pylons-sphinx-themes >= 1.0.8', # Ethical Ads
'pylons_sphinx_latesturl',
Expand Down