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.

Sign up for GitHub

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

Jump to bottom

PDF version of Language Documentation on readthedocs lacks most Unicode characters #2153

Closed
Araneidae opened this issue Aug 26, 2016 · 7 comments
Closed

PDF version of Language Documentation on readthedocs lacks most Unicode characters #2153

Araneidae opened this issue Aug 26, 2016 · 7 comments
Assignees
@asr
Labels
type: bug Issues and pull requests about actual bugs ux: documentation Issues relating to Agda's documentation
Milestone
2.6.0

Comments

@Araneidae
Copy link

The PDF version of the language documentation available on readthedocs seems to lack nearly all Unicode characters, for example the code and accompanying narrative on page 6 (for Release 2.6.0) looks extremely odd.

As the wiki directs me straight to readthedocs for the language reference, I presume it's the canonical reference point for the documentation...
@gallais
Copy link
Member

gallais commented Aug 26, 2016

This seems relevant. We can maybe generate such a preambule from the list in agda-input.el?

@asr
Copy link
Member

asr commented Aug 26, 2016

At the moment (by using XeLaTeX instead of LaTeX) you can locally generated a PDF with very few missing Unicode characters running

$ cd doc/user-manual
$ make latexpdf PDFLATEX=xelatex

@asr asr added type: bug Issues and pull requests about actual bugs ux: documentation Issues relating to Agda's documentation labels Oct 8, 2016
@asr asr mentioned this issue Oct 8, 2016
Closed
@asr
Copy link
Member

asr commented Oct 8, 2016

Blocked by readthedocs/readthedocs.org#1556.

@asr asr added the status: blocked-by-issue This pull request is blocked on an open issue. label Oct 8, 2016
@ejeschke ejeschke mentioned this issue May 16, 2018
Closed
@UlfNorell UlfNorell added this to the icebox milestone May 29, 2018
@ice1000
Copy link
Member

ice1000 commented Nov 10, 2018

readthedocs/readthedocs.org#1556 (comment)
readthedocs/readthedocs.org#1556 (comment)

@nad
Copy link
Contributor

nad commented Nov 12, 2018

What is the use case for the PDF document? Perhaps the HTML manual suffices.

If you really think that we should have a PDF manual, then I suggest that we include \tracinglostchars=2 in the document's preamble, and check that there are no warnings about problematic characters.

asr added a commit that referenced this issue Jan 7, 2019
@asr
[ #2153 ] Preparation for fixing the issue.
764038c 
* Required Sphinx >= 1.8.3.

* The installation of Sphinx must use `pip3` instead of `pip`.

* User manual: Updated `Makefile` and `conf.py` using the Sphinx 1.8.3
  templates.

  (I still miss a `make upgrade` option (see
  sphinx-doc/sphinx#61))
@asr asr self-assigned this Jan 7, 2019
@asr asr modified the milestones: icebox, 2.6.0 Jan 7, 2019
@asr asr removed the status: blocked-by-issue This pull request is blocked on an open issue. label Jan 7, 2019
@asr
Copy link
Member

asr commented Jan 7, 2019

Please note as mentioned in the above commit (764038c) that the installation of Sphinx must use pip3 instead of pip. You can install Sphinx and sphinx-rtd-theme by running

pip3 install --user -r doc/user-manual/requirements.txt

@asr asr closed this as completed in 34e9b35 Jan 8, 2019
asr added a commit that referenced this issue Jan 8, 2019
@asr
[ #2153 ] Using an external LaTeX file in conf.py.
f420607
asr added a commit that referenced this issue Jan 12, 2019
@asr
[ #2153 ] Preparation for fixing the issue (#3369).
db5ea51 
* Required Sphinx >= 1.8.3.

* The installation of Sphinx must use `pip3` instead of `pip`.

* User manual: Updated `Makefile` and `conf.py` using the Sphinx 1.8.3
  templates.

  (I still miss a `make upgrade` option (see
  sphinx-doc/sphinx#61))

(cherry picked from commit 764038c)
asr added a commit that referenced this issue Jan 12, 2019
@asr
[ fixed #2153 ] Handled some Unicode symbols (#3369).
a132c50 
Handled some Unicode symbols in the PDF version of the user manual.

(cherry picked from commit 34e9b35)
asr added a commit that referenced this issue Jan 12, 2019
@asr
[ #2153 ] Using an external LaTeX file in conf.py (#3369).
452b050 
(cherry picked from commit f420607)
@asr asr modified the milestones: 2.6.0, 2.5.4.3 Jan 12, 2019
@asr
Copy link
Member

asr commented Jan 12, 2019

Back-ported into 2.5.4.3.

@asr asr modified the milestones: 2.5.4.3, 2.6.0 Feb 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@asr asr

Labels
type: bug Issues and pull requests about actual bugs ux: documentation Issues relating to Agda's documentation
Projects
None yet
Milestone
2.6.0
Development

No branches or pull requests
6 participants
@nad @UlfNorell @asr @gallais @Araneidae @ice1000