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

HTML manual is not correct #570

Closed
prjemian opened this issue Jun 9, 2017 · 4 comments
Closed

HTML manual is not correct #570

prjemian opened this issue Jun 9, 2017 · 4 comments
Labels
bug help wanted high priority
Milestone
NXDL 3.3

Comments

@prjemian
Copy link
Contributor

prjemian commented Jun 9, 2017

Since #568, the HTML manual as-built is not correct. In NXreflections, the flags field should have more content (additional paragraph and a table). Both are missing.

Could be related to #567 (build errors with LaTeX). However, in this case, for the HTML manual, the HTML documentation builds properly on my server (using Sphinx 1.5.4).

jenkins server uses Sphinx 1.4.8
@prjemian prjemian added this to the NeXus definitions 3.3 milestone Jun 9, 2017
@prjemian
Copy link
Contributor Author

prjemian commented Jun 9, 2017

Might be useful to build the manual (both HTML and PDF) on the travis-ci server where the configure script can be made to control the version of Sphinx that is used.

@prjemian
Copy link
Contributor Author

prjemian commented Jun 9, 2017

The NXreflections page is not updated. New (or changed) content from commits 685efde & 6b6e128 (such as symbols) is not shown at this time.

@prjemian
Copy link
Contributor Author

@phyy-nx : If you wonder why the NXreflections base class does not yet appear in the documentation (even with #574 closed), this issue describes the underlying problem. Wondering now if it is possible to build the docs on readthedocs.io now?

prjemian added a commit that referenced this issue Jun 14, 2017
@prjemian
#570 turn off PDF manual for now
449b403
@prjemian prjemian mentioned this issue Jun 14, 2017
Closed
@prjemian
Copy link
Contributor Author

With 449b403, this issue is fixed. The flags field has the expected content now. LaTeX build errors (#567) will be resolved separately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug help wanted high priority
Projects
None yet
Milestone
NXDL 3.3
Development

No branches or pull requests
1 participant
@prjemian