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

Octave pkg and Texinfo/QHelp support #28

Closed
apjanke opened this issue Mar 2, 2019 · 1 comment
Closed

Octave pkg and Texinfo/QHelp support #28

apjanke opened this issue Mar 2, 2019 · 1 comment
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@apjanke
Copy link
Owner

apjanke commented Mar 2, 2019

This thing needs to be installable as an Octave pkg package. Needs:

  • Installability from a release URL
  • Qt QHelp documentation support so doc <whatever> works

Use octave-chrono as a model for this. Except, now that this has a class with a bunch of methods, would be nice to add support for multi-part Texinfo documentation where each Texinfo fragment is positioned in the source code next to the method it's documenting, instead of requiring it all to be in a single block at the top of the classdef file.

Supporting multiple Texinfo blocks has some complications: helptext blocks attached to methods are logically associated with the methods, and they can be reordered based on class structure by the helptext interpreter. Texinfo is a linear document, and simply concatenating multiple Texinfo blocks found within the source code would tie the document structure to the source code ordering. Sigh.

Doing this will require additional build/release steps. Oh well; it's necessary.

@apjanke apjanke self-assigned this Mar 2, 2019
@apjanke apjanke added the enhancement New feature or request label Mar 2, 2019
@apjanke apjanke added this to the 1.0 milestone Mar 2, 2019
@apjanke apjanke changed the title Octave pkg support Octave pkg and Texinfo/QtHelp support Mar 2, 2019
@apjanke apjanke changed the title Octave pkg and Texinfo/QtHelp support Octave pkg and Texinfo/QHelp support Mar 3, 2019
@apjanke
Copy link
Owner Author

apjanke commented Apr 30, 2019

Okay, I added support for multi-block Texinfo doco here and in octave-chrono, and it's working out fine. Also added support for classes and namespaces in it.

You can install from master using the github archive URL, and that's in the README. So I think this is done.

@apjanke apjanke closed this as completed Apr 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant