Has anyone worked on a happydoc formatter for HTML but using heading tags for the hierarchy instead of tables?
If I wanted to write my own HTML formatter, where would I start? Is there additional documentation on how to write formatters, or how the different parts of HappyDoc (docstring, docset, formatters) interact?
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Unfortunately I never took the time to write a lot of developer documentation outside of the comments and docstrings in the source.
I am working on integrating TAL (from Zope's PageTemplates) with HappyDoc 3.0, so it should be much simpler to create your own templates when I get around to finishing that work.
In the mean time, you may want to start by checking out the HappyDoc 3.0 source from CVS (in the HappyDoc3 module). The notion of formatter and docset have been merged, and it should be *much* simpler to understand what you need to implement by looking at the existing docset.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I have not finished enough of it to make it installable yet, but you can run it right out of the directory where you check it out. It should generate documentation that looks similar to the current default output from the release version of HappyDoc, with some minor differences (like breadcrumbs and a few formatting tweaks). If you have problems, let me know, because that probably means I forgot to check in a file. :-)
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Has anyone worked on a happydoc formatter for HTML but using heading tags for the hierarchy instead of tables?
If I wanted to write my own HTML formatter, where would I start? Is there additional documentation on how to write formatters, or how the different parts of HappyDoc (docstring, docset, formatters) interact?
Unfortunately I never took the time to write a lot of developer documentation outside of the comments and docstrings in the source.
I am working on integrating TAL (from Zope's PageTemplates) with HappyDoc 3.0, so it should be much simpler to create your own templates when I get around to finishing that work.
In the mean time, you may want to start by checking out the HappyDoc 3.0 source from CVS (in the HappyDoc3 module). The notion of formatter and docset have been merged, and it should be *much* simpler to understand what you need to implement by looking at the existing docset.
Thanks.
HappyDoc3 has no setup file. How do I install it? For that matter, is it in a working state yet?
I have not finished enough of it to make it installable yet, but you can run it right out of the directory where you check it out. It should generate documentation that looks similar to the current default output from the release version of HappyDoc, with some minor differences (like breadcrumbs and a few formatting tweaks). If you have problems, let me know, because that probably means I forgot to check in a file. :-)