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

Undefined control sequence. \sphinxmaketitle #6641

Closed
Routhinator opened this issue Aug 13, 2019 · 4 comments
Closed

Undefined control sequence. \sphinxmaketitle #6641

Routhinator opened this issue Aug 13, 2019 · 4 comments

Comments

@Routhinator
Copy link

Describe the bug
Latext build fails due to unrecognized Sphinx control sequences.

! Undefined control sequence.
l.84 \sphinxmaketitle

To Reproduce
Steps to reproduce the behavior:

sphinx-build -M latex docs docs_output
cd docs_output/latex
make

Expected behavior
Make should have produced a PDF document.

Your project
https://gitlab.routh.io/minecraft/launchers/routh-io-skcraft

Environment info

  • OS: Ubuntu 18.04
  • Python version: 3.6
  • Sphinx version: v2.1.2
  • Sphinx extensions: autodoc, intersphinx, viewcode, coverage, todo, javasphinx
  • Extra tools: Gitlab CI

Additional context

Error output

[Loading MPS to PDF converter (version 2006.09.02).]
) (/usr/share/texlive/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty
(/usr/share/texlive/texmf-dist/tex/latex/oberdiek/grfext.sty)
(/usr/share/texlive/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg))
*geometry* driver: auto-detecting
*geometry* detected driver: pdftex
(/usr/share/texlive/texmf-dist/tex/latex/hyperref/nameref.sty
(/usr/share/texlive/texmf-dist/tex/generic/oberdiek/gettitlestring.sty))
! Undefined control sequence.
l.84 \sphinxmaketitle
                     
? 
! Emergency stop.
l.84 \sphinxmaketitle
                     
!  ==> Fatal error occurred, no output PDF file produced!
Transcript written on routh-io-skcraft-launcher-docs.log.
Latexmk: Index file 'routh-io-skcraft-launcher-docs.idx' was written
Latexmk: Errors, so I did not complete making targets
@jfbu
Copy link
Contributor

jfbu commented Aug 19, 2019

The \sphinxmaketitle macro is defined via the LaTeX document loading either sphinxhowto.cls or sphinxmanual.cls file, corresponding to choice of 'howto' or 'manual' in latex_documents configuration variable. Yours has

latex_documents = [
    (master_doc, 'routh-io-skcraft-launcher-docs.tex', project,
     author, 'book')
]

which contains 'book'. Please try using configuration seeting latex_docclass

latex_documents = [
    (master_doc, 'routh-io-skcraft-launcher-docs.tex', project,
     author, 'manual')
]
latex_docclass = {'manual': 'book'}

@jfbu
Copy link
Contributor

jfbu commented Aug 25, 2019

Does my comment solve your problem? I would like to close this.

@jfbu
Copy link
Contributor

jfbu commented Sep 2, 2019

Actually sorry, I think we do have a bug here. The documentation of 'latex_documents' allows using own classes rather than 'howto' and 'manual' Sphinx ones. Hence indeed Sphinx LaTeX should not rely on macros being defined only in its own LaTeX class files.

@jfbu jfbu added this to the 2.2.1 milestone Sep 2, 2019
jfbu added a commit to jfbu/sphinx that referenced this issue Sep 2, 2019
jfbu added a commit that referenced this issue Sep 14, 2019
Fix #6641: Undefined control sequence \sphinxmaketitle
@jfbu
Copy link
Contributor

jfbu commented Sep 14, 2019

Fixed at 59890a3

Thanks for reporting!

@jfbu jfbu closed this as completed Sep 14, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants