You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doc@openoffice.apache.org by Alexandro Colorado <jz...@oooes.org> on 2014/06/14 23:00:12 UTC
Documentation design for API Ref and other technical documentation
Hi spending some time with the Odoo community (previously OpenERP) I
learn some other workflows of dealing with documenation. Being a
python shop they rely heavily on sphinx a documentation framework to
generate techical documentation about their ERP.
I want to research on how we generate our own API documenation and
where can I see those scripts.
http://www.openoffice.org/api/modules.html
As well as other type of documenation like code examples, C++
(http://www.openoffice.org/api/docs/cpp/ref/names/index.html) Java
(http://www.openoffice.org/api/docs/java/ref/overview-summary.html)
and finally the IDL reference
(http://www.openoffice.org/api/docs/common/ref/com/sun/star/module-ix.html).
Regards.
--
Alexandro Colorado
Apache OpenOffice Contributor
882C 4389 3C27 E8DF 41B9 5C4C 1DB7 9D1C 7F4C 2614
---------------------------------------------------------------------
To unsubscribe, e-mail: doc-unsubscribe@openoffice.apache.org
For additional commands, e-mail: doc-help@openoffice.apache.org
Re: Documentation design for API Ref and other technical
documentation
Posted by Ariel Constenla-Haile <ar...@apache.org>.
On Sat, Jun 14, 2014 at 04:00:12PM -0500, Alexandro Colorado wrote:
> Hi spending some time with the Odoo community (previously OpenERP) I
> learn some other workflows of dealing with documenation. Being a
> python shop they rely heavily on sphinx a documentation framework to
> generate techical documentation about their ERP.
>
> I want to research on how we generate our own API documenation and
> where can I see those scripts.
There are no scripts; in the source tree, the html API reference is
generated from IDL files just the same way as when you download the SDK,
see <SDK inst. dir.>/docs/tools.html
autodoc is located in trunk/main/autodoc and is written in C++.
Regards
--
Ariel Constenla-Haile
La Plata, Argentina
Re: Documentation design for API Ref and other technical documentation
Posted by Jürgen Schmidt <jo...@gmail.com>.
On 14/06/14 23:00, Alexandro Colorado wrote:
> Hi spending some time with the Odoo community (previously OpenERP) I
> learn some other workflows of dealing with documenation. Being a
> python shop they rely heavily on sphinx a documentation framework to
> generate techical documentation about their ERP.
>
> I want to research on how we generate our own API documenation and
> where can I see those scripts.
>
> http://www.openoffice.org/api/modules.html
>
> As well as other type of documenation like code examples, C++
> (http://www.openoffice.org/api/docs/cpp/ref/names/index.html) Java
> (http://www.openoffice.org/api/docs/java/ref/overview-summary.html)
> and finally the IDL reference
> (http://www.openoffice.org/api/docs/common/ref/com/sun/star/module-ix.html).
All this reference documentation is part of the SDK and built during the
normal build process in the odk module.
The C++ and Java ref covers the API's that we have marked as part of the
UNO runtime environment and that should be kept compatible at least
between majors.
The documentation online reflect more or less the latest SDK version. I
try to keep it up to date.
Juergen
---------------------------------------------------------------------
To unsubscribe, e-mail: api-unsubscribe@openoffice.apache.org
For additional commands, e-mail: api-help@openoffice.apache.org