Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Sphinx/guidelines
< Sphinx
Revision as of 04:05, 29 April 2014 by Yue.ma.itemis.com (Talk | contribs) (Created page with "==Git Repository Layout== The source code will be in a single Git repository, organized in the following directories: # plugins: source code for all the plug-ins of Sphinx it...")
Git Repository Layout
The source code will be in a single Git repository, organized in the following directories:
- plugins: source code for all the plug-ins of Sphinx itself;
- doc: the documentation plug-ins;
- examples: example Sphinx modelers and sample metamodel definitions used by the examples and/or the tests;
- tests: automated tests (JUnit);
- features: feature definitions (including doc, examples and test features);
- releng: parent project (for the root POM and shared files), target platform definitions, update-sites definitions;
- tools: source code for development tools that contributors must install in their development environment. These are not part of Sphinx but are required to develop Sphinx.