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

eodoc: generator of HTML documentation from EO sources #369

Open
yegor256 opened this issue Nov 4, 2024 · 0 comments
Open

eodoc: generator of HTML documentation from EO sources #369

yegor256 opened this issue Nov 4, 2024 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@yegor256
Copy link
Member

yegor256 commented Nov 4, 2024

We need to create a documentation generator. It has to be called as eoc doc. It should execute register and parse beforehand, and then simply scan all available .xml files take object documentation from it, for example:

# This is the documentation, explaining how to use
# this object:
#
# ```
# this is fixed-font
# Markdown block
# ```
#
# Markdown can be here [too](some-link)
[x] > foo
  Q.io.stdout > @
    "Hello, world!\n"

Here, the entire block above the object will be in the XML produced by the parser. We should create xxx.html for each xxx.xml file. It would be great to use XSL for this generator. Also, we should create HTML files for each package, similar to how JavaDoc does it.

@yegor256 yegor256 added enhancement New feature or request help wanted Extra attention is needed labels Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant