Git Product home page Git Product logo

Comments (3)

arthurzam avatar arthurzam commented on July 1, 2024 1

Current progress can be viewed here.
This is a fully generated eclass docs as part of devmanual's Makefile, which only external need is the location of ::gentoo repo.
There are still currently issues, and many future docs fixes needed, but we are close!

from pkgcore.

ulm avatar ulm commented on July 1, 2024

The final target is a good generator used for app-doc/eclass-manpages and for devmanual. There is a need for adding missing sections, and cleaning a lot of things! ulm requested the output as DocBook output. There are existing RST to DocBook convertors.

Not DocBook, but DevBook XML. See human readable and formal specs. It's a pretty simple format, especially when limited to eclass documentation, where there are no complicated elements like tables or figures.

If this should prove to be too difficult, then HTML would also be acceptable (after all, that's what we have now).

from pkgcore.

arthurzam avatar arthurzam commented on July 1, 2024

First of all, thank you @ulm for pointing me into the correct format (no idea how I managed to mistake docbook and devbook).
I'm now in the process of writing a translator from rst to devbook (your links to explanation and spec were spot on). It progresses not bad, and the remaining shouldn't be too hard.

I think if this finishes as intended, we will have a good eclassdoc → {rst,manpage,devbook} convertor. Then I think we can decide that eclassdoc is rst format (not so far from current state, and then devs can better format them). Finally, I guess I can do a traversal of the eclasses to improve the format of eclassdoc, to better confirm. Main issues I find:

  • missing blank line between bullet list items.
  • too big indent for second line of explanations in bullet lists, which make it mistake with a definition list.

from pkgcore.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.