Tasks #1263
Use rosetta-doc to integrate descriptions of data types into RST manual
| Status: | Resolved | Start date: | 11/26/2012 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: | J. Moringen | % Done: | 100% | |
| Category: | documentation | |||
| Target version: | Robotics Service Bus - rsb-0.9 |
Related issues
Associated revisions
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Ignore proto files whose names start with "__"
refs #1263
- project/codeCheck.py: ignore proto files whose names start with "__"
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
refs #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
refs #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox), collect a list of IDL files
via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta-doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox, deprecated), collect a list
of IDL files via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
Use rosetta-doc tool to generate descriptions of data types
fixes #1263
The process is as follows
1. For each domain (e.g. stable, sandbox, deprecated), collect a list
of IDL files via e.g. "/proto/${DOMAIN}/**/*.proto"
2. Call rosetta doc on these files producing the respective
e.g. "/generated/${DOMAIN}/**/*.rst" files
3. Call sphinx-build to generate HTML or some other output based on
the manually written "/*.rst" and "/generated/**/*.rst"
- data-types.rst: removed static description of RST packages; instead
include generated documentation for "stable" and "sandbox" domains - conf.py.in: added graphviz extension which is required by
rosetta-doc; added intersphinx entry for the rosetta manual - CMakeLists.txt: find rosetta-doc program; added RSB_MANUAL_DIR and
ROSETTA_MANUAL_DIR; added function document_domain which calls
rosetta-doc on all IDL files of a domain; call document_domain for
stable and sandbox domains; let sphinx-build targets depend on
generated rst files - _static/message.svg: new file; icon for message definitions
- _static/package.svg: new file; icon for package definitions
- _templates/links.html.in: added link to rosetta manual
- corlab/static/corlab.css: added styles for message and package lists
- .gitignore: added directory "/generated" to ignore patterns
History
#1 Updated by J. Moringen over 11 years ago
- Tracker changed from Bug to Tasks
- % Done changed from 0 to 50
#2 Updated by J. Moringen over 11 years ago
- Status changed from In Progress to Resolved
- % Done changed from 50 to 100
Applied in changeset rst-manual|commit:02e7cbe84138955f523f60f46e1c2a6a9da29669.