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

problems with pdb documentation #615

Closed
prjemian opened this issue Mar 18, 2018 · 2 comments
Closed

problems with pdb documentation #615

prjemian opened this issue Mar 18, 2018 · 2 comments
Assignees
Labels
Milestone

Comments

@prjemian
Copy link
Contributor

Problems with reST syntax in PR #614 (and issue #553)

NeXus/definitions/build/manual/source/classes/base_classes/NXpdb.rst:50: SEVERE: Unexpected section title or transition.

=====================================================================================
NeXus/definitions/build/manual/source/classes/base_classes/NXpdb.rst:54: ERROR: Unexpected indentation.
NeXus/definitions/build/manual/source/classes/base_classes/NXpdb.rst:55: WARNING: Block quote ends without a blank line; unexpected unindent.
NeXus/definitions/build/manual/source/classes/base_classes/NXpdb.rst:68: SEVERE: Unexpected section title or transition.

=====================================================================================
NeXus/definitions/build/manual/source/classes/base_classes/NXpdb.rst:72: SEVERE: Unexpected section title or transition.

=====================================================================================
NeXus/definitions/build/manual/source/classes/base_classes/NXpdb.rst:86: SEVERE: Unexpected section title or transition.

=====================================================================================
NeXus/definitions/build/manual/source/classes/base_classes/NXpdb.rst:55: ERROR: Unknown target name: "loop".
@prjemian prjemian added the bug label Mar 18, 2018
@prjemian prjemian added this to the NXDL 2018.3 milestone Mar 18, 2018
@prjemian prjemian self-assigned this Mar 18, 2018
@prjemian
Copy link
Contributor Author

when showing computer code in reST, need to use "::" on preceding line of prose, then indent the computer code, such as this line of reST

the following code shows how to document computer code::

    print("Hello, world.")

which renders like this:


the following code shows how to document computer code::

    print("Hello, world.")

prjemian added a commit that referenced this issue Mar 18, 2018
@zjttoefs zjttoefs modified the milestones: NXDL 2018.4, NXDL 2018.10 May 2, 2018
@zjttoefs
Copy link
Contributor

zjttoefs commented May 8, 2018

Since this will be merged when #614 is merged it can be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants