diff --git a/docs/bioformats-release-process.rst b/docs/bioformats-release-process.rst index 2e206bc..d453145 100644 --- a/docs/bioformats-release-process.rst +++ b/docs/bioformats-release-process.rst @@ -1,5 +1,5 @@ -BioFormats release -================== +Bio-Formats release +=================== .. _Bio-Formats: https://github.com/ome/bioformats .. _Bio-Formats Documentation: https://github.com/ome/bio-formats-documentation diff --git a/docs/build-and-release.rst b/docs/build-and-release.rst new file mode 100644 index 0000000..6cea1bf --- /dev/null +++ b/docs/build-and-release.rst @@ -0,0 +1,38 @@ +Build and Release +================= + +The following sections summarize the development and release processes followed by the OME team. + + + +Build +----- + +.. toctree:: + :maxdepth: 1 + + ansible-development + schema-changes + continuous-integration + data-model-schema + editing-docs + jekyll + development-tools + deployment-tools + +Release +------- + +.. toctree:: + :maxdepth: 1 +.. toctree:: + :maxdepth: 1 + + bioformats-release-process + cpp-development + gradle-development + java-development + omero-release-process + omero-web-release-process + python-components + \ No newline at end of file diff --git a/docs/components-release.rst b/docs/components-release.rst deleted file mode 100644 index 8315685..0000000 --- a/docs/components-release.rst +++ /dev/null @@ -1,18 +0,0 @@ -Components release -================== - -The following sections summarize the release process of the various components of the software stack. -Note this is not an exhaustive list of all tools release process. - - -.. toctree:: - :maxdepth: 1 - - bioformats-release-process - cpp-development - gradle-development - java-development - python-components - omero-release-process - omero-web-release-process - \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index a325359..14c5f9d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -275,6 +275,8 @@ def copy_legacy_redirects(app, exception): print(" %s" % html_src_path) +html_theme = "sphinx_rtd_theme" + def setup(app): app.connect('build-finished', copy_legacy_redirects) diff --git a/docs/general.rst b/docs/general.rst new file mode 100644 index 0000000..ca83f32 --- /dev/null +++ b/docs/general.rst @@ -0,0 +1,15 @@ +Getting Started +=============== + +The following sections summarize general work practises followed by the OME team. + + +.. toctree:: + :maxdepth: 1 + + source-code + using-git + code-contributions + cla + team-communication + team-workflow diff --git a/docs/index.rst b/docs/index.rst index ca54130..e5fee00 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,26 +7,15 @@ consortium projects. It includes internal developer practices and workflows, standard procedures for tasks such as release, and other information which may be valuable to a wider audience. + .. toctree:: :maxdepth: 1 - source-code - using-git - code-contributions - cla - team-communication - team-workflow - ansible-development - development-tools - deployment-tools - continuous-integration - editing-docs - jekyll - data-model-schema - schema-changes - components-release + general + build-and-release testing_scenarios/index + Information specific to developing OMERO, the OME Data Model and file formats, and Bio-Formats can be found in their respective developer documentation sections: diff --git a/docs/testing_scenarios/index.rst b/docs/testing_scenarios/index.rst index 377cb75..3d595ba 100644 --- a/docs/testing_scenarios/index.rst +++ b/docs/testing_scenarios/index.rst @@ -8,7 +8,7 @@ Testing scenarios .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :numbered: 2 TablePermissionsUsers