Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

TODO: rebase Add info build target in doc/Makefile #1415

Merged
merged 1 commit into from

6 participants

@tkf

I added build targets to compile SymPy document into an info file. However, it does not work as is. I get the following error when tried to build (using make info).

I need to use makeinfo --force --no-split -o sympy.info sympy.texi to force compile. Probably this is a bug in texinfo Sphinx writer. I will report upstream.

Can this PR be merged once it is fixed in the upstream (Sphinx)?

Running Texinfo files through makeinfo...
make -C _build/texinfo info
make[1]: Entering directory `/.../sympy/doc/_build/texinfo'
makeinfo --no-split -o 'sympy.info' 'sympy.texi'
sympy.texi:136376: Node `Python Module Index' previously defined at line 136213.
/.../sympy/doc/_build/texinfo//sympy.texi:136213: Prev field of node `Python Module Index' not pointed to.
/.../sympy/doc/_build/texinfo//sympy.texi:136213: This node (Python Module Index) has the bad Next.
/.../sympy/doc/_build/texinfo//sympy.texi:135446: Next field of node `About' not pointed to (perhaps incorrect sectioning?).
/.../sympy/doc/_build/texinfo//sympy.texi:136213: This node (Python Module Index) has the bad Prev.
makeinfo: Removing output file `sympy.info' due to errors; use --force to preserve.
make[1]: *** [sympy.info] Error 1
make[1]: Leaving directory `/.../sympy/doc/_build/texinfo'
make: *** [info] Error 2
@travisbot

This pull request fails (merged 4bec0098 into 387547b).

@Krastanov
Collaborator

SymPy Bot Summary: :red_circle: There were test failures.

@tkf: Please fix the test failures.

Test command: setup.py test
master hash: 387547b
branch hash: 4bec0098a190e2016f6a34ba25f321a1aa9faa2d

Interpreter 1: :red_circle: There were test failures.

Interpreter: /usr/local/bin/python2.5 (2.5.6-final-0)
Architecture: Linux (64-bit)
Cache: yes

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sY0_0fDA

Interpreter 2: :red_circle: There were test failures.

Interpreter: /usr/bin/python2.7 (2.7.3-candidate-2)
Architecture: Linux (64-bit)
Cache: yes

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sYmeYfDA

Interpreter 3: :red_circle: There were test failures.

Interpreter: /usr/bin/python3.2 (3.2.3-candidate-2)
Architecture: Linux (64-bit)
Cache: yes

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sY1qQgDA

Build HTML Docs: :red_circle: There were test failures.

Docs build command: make html-errors
Sphinx version: 1.1.3

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sYpo0gDA

Automatic review by SymPy Bot.

@tkf

The bug is fixed in the upstream
https://bitbucket.org/jonwaltman/sphinx-info/issue/1/error-this-node-python-module-index-has

Now make info finishes without the error.

@travisbot

This pull request passes (merged 998ac90b into 861a066).

@Krastanov
Collaborator

SymPy Bot Summary: :red_circle: There were test failures.

@tkf: Please fix the test failures.

Test command: setup.py test
master hash: 861a066
branch hash: 998ac90bc8887135e95c5aade67b5b2e95a73b46

Interpreter 1: :eight_spoked_asterisk: All tests have passed.

Interpreter: /usr/local/bin/python2.5 (2.5.6-final-0)
Architecture: Linux (64-bit)
Cache: yes

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sYrtUiDA

Interpreter 2: :red_circle: There were test failures.

Interpreter: /usr/bin/python2.7 (2.7.3-candidate-2)
Architecture: Linux (64-bit)
Cache: yes

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sY8pYiDA

Interpreter 3: :red_circle: There were test failures.

Interpreter: /usr/bin/python3.2 (3.2.3-candidate-2)
Architecture: Linux (64-bit)
Cache: yes

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sYrdUiDA

Build HTML Docs: :red_circle: There were test failures.

Docs build command: make html-errors
Sphinx version: 1.1.3

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sYj7YiDA

Automatic review by SymPy Bot.

@JonWaltman

The problem was due to Sphinx not handling duplicate entries for the Python Module Index. The is fixed in my repo which will probably be merged upstream before the next Sphinx release. (Bitbucket pull request)

The duplicate entries were caused by an issue with the numpydoc sphinx extensions. I have sent a pull request (numpy/numpy#379) to the numpy people to fix the problem which avoids the duplicate entries.

If the numpy pull request is accepted and you update your copy of numpydoc.py to the newer version, the texinfo build should work with the current version of sphinx. (Also, your html docs will not have duplicate modules links in the headers/footers)

@certik
Owner

@tkf, would you mind rebasing your patch? It doesn't apply cleanly.

Otherwise if it works, I'll merge it.

@asmeurer
Owner

By the way, the merge conflict is trivial.

@asmeurer
Owner

SymPy Bot Summary: :exclamation: There were merge conflicts (could not merge tkf/texinfo (998ac90bc8887135e95c5aade67b5b2e95a73b46) into master (0336f70)); could not test the branch.
@tkf: Please rebase or merge your branch with master. See the report for a list of the merge conflicts.

@asmeurer
Owner

SymPy Bot Summary: :exclamation: There were merge conflicts (could not merge tkf/texinfo (998ac90bc8887135e95c5aade67b5b2e95a73b46) into master (0336f70)); could not test the branch.
@tkf: Please rebase or merge your branch with master. See the report for a list of the merge conflicts.
:exclamation: *Python *: There were merge conflicts; could not test the branch.

@tkf

Thanks. Rebased.

@travisbot

This pull request passes (merged 01cb8c8 into 3b77c94).

@Krastanov
Collaborator

SymPy Bot Summary: :eight_spoked_asterisk: All tests have passed.

Test command: setup.py test
master hash: 3b77c94
branch hash: 01cb8c8

Interpreter 1: :eight_spoked_asterisk: All tests have passed.

Interpreter: /usr/local/bin/python2.5 (2.5.6-final-0)
Architecture: Linux (64-bit)
Cache: yes

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sYqrMjDA

Interpreter 2: :eight_spoked_asterisk: All tests have passed.

Interpreter: /usr/bin/python2.7 (2.7.3-candidate-2)
Architecture: Linux (64-bit)
Cache: yes

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sYncYiDA

Interpreter 3: :eight_spoked_asterisk: All tests have passed.

Interpreter: /usr/bin/python3.2 (3.2.3-candidate-2)
Architecture: Linux (64-bit)
Cache: yes

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sYtu0iDA

Build HTML Docs: :eight_spoked_asterisk: All tests have passed.

Docs build command: make html-errors
Sphinx version: 1.1.3

Test results html report: http://reviews.sympy.org/report/agZzeW1weTNyDAsSBFRhc2sY76MjDA

Automatic review by SymPy Bot.

@certik
Owner

Thanks!

@certik certik merged commit b358fff into sympy:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Aug 11, 2012
  1. @tkf
This page is out of date. Refresh to see the latest.
Showing with 24 additions and 0 deletions.
  1. +17 −0 doc/Makefile
  2. +7 −0 doc/src/conf.py
View
17 doc/Makefile
@@ -25,6 +25,8 @@ help:
@echo " web to make files usable by Sphinx.web"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
@echo " changes to make an overview over all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " cheatsheet to make the Cheatsheet"
@@ -126,3 +128,18 @@ cheatsheet:
mkdir -p _build/cheatsheet
pdflatex -output-directory=_build/cheatsheet cheatsheet/cheatsheet.tex
pdflatex -output-directory=_build/cheatsheet cheatsheet/cheatsheet.tex
+
+texinfo:
+ mkdir -p _build/texinfo
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) _build/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in _build/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ mkdir -p _build/texinfo
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) _build/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C _build/texinfo info
+ @echo "makeinfo finished; the Info files are in _build/texinfo."
View
7 doc/src/conf.py
@@ -155,3 +155,10 @@
'\\usepackage{amsfonts}\n'+\
'\\usepackage{amssymb}\n'+\
'\\setlength{\\parindent}{0pt}\n'
+
+texinfo_documents = [
+ (master_doc, 'sympy', 'SymPy Documentation',
+ 'SymPy Development Team',
+ 'SymPy', 'Computer algebra system (CAS) in Python', 'Programming',
+ 1),
+]
Something went wrong with that request. Please try again.