diff --git a/README.md b/README.md index 800a7c2..58c57e1 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ gCube CMS Suite -------------------------------------------------- -gCube CMS Suite is a distributed full stack application for publication management in a gCube Hybrid e-infrastructure. Check wiki [here]() +gCube CMS Suite is a distributed full stack application for publication management in a gCube Hybrid e-infrastructure. Check wiki [here](https://sublime-and-sphinx-guide.readthedocs.io) [](https://www.sphinx-doc.org/en/master/) @@ -16,7 +16,7 @@ The suite comes with a set of pre-built plugins and GUIs that comunuties can eas ## Documentation -* [Dedicated Wiki]() - TBD Powered by [Sphynx](https://www.sphinx-doc.org/en/master/) +* [Dedicated Wiki](https://sublime-and-sphinx-guide.readthedocs.io) - TBD Powered by [Sphynx](https://www.sphinx-doc.org/en/master/) * [Service Interactive API]() -TBD Powered by [Enunciate](http://enunciate.webcohesion.com/) * [Gcube System Wiki](https://gcube.wiki.gcube-system.org/gcube/GeoPortal). * [Guide Notebooks](use-cases) - Powered by [Jupyter](https://jupyter.org/) diff --git a/sdi-plugins/README.md b/sdi-plugins/README.md index 6977a4d..e88b451 100644 --- a/sdi-plugins/README.md +++ b/sdi-plugins/README.md @@ -5,7 +5,7 @@ gCube CMS Suite : SDI Plugins ## Documentation -* [Dedicated Wiki]() - TBD Powered by [Sphynx](https://www.sphinx-doc.org/en/master/) +* [Dedicated Wiki](https://sublime-and-sphinx-guide.readthedocs.io) - TBD Powered by [Sphynx](https://www.sphinx-doc.org/en/master/) * [Service Interactive API]() -TBD Powered by [Enunciate](http://enunciate.webcohesion.com/) * [Gcube System Wiki](https://gcube.wiki.gcube-system.org/gcube/GeoPortal). * [Guide Notebooks](../use-cases) - Powered by [Jupyter](https://jupyter.org/) diff --git a/use-cases/README.md b/use-cases/README.md index 3948e63..4a2b307 100644 --- a/use-cases/README.md +++ b/use-cases/README.md @@ -5,7 +5,7 @@ gCube CMS Suite : Use cases ## Documentation -* [Dedicated Wiki]() - TBD Powered by [Sphynx] (https://www.sphinx-doc.org/en/master/) +* [Dedicated Wiki](https://sublime-and-sphinx-guide.readthedocs.io) - TBD Powered by [Sphynx] (https://www.sphinx-doc.org/en/master/) * [Service Interactive API]() -TBD Powered by [Enunciate] (http://enunciate.webcohesion.com/) * [Gcube System Wiki] - (https://gcube.wiki.gcube-system.org/gcube/GeoPortal). * [Guide Notebooks](use-cases) - Powered by [Jupyter] (https://jupyter.org/) diff --git a/use-cases/pom.xml b/use-cases/pom.xml index 633d959..e53fdd2 100644 --- a/use-cases/pom.xml +++ b/use-cases/pom.xml @@ -83,6 +83,7 @@ 2.10.0 html + src/site/sphinx diff --git a/use-cases/src/site/sphinx/conf.py b/use-cases/src/site/sphinx/conf.py new file mode 100644 index 0000000..b1e8072 --- /dev/null +++ b/use-cases/src/site/sphinx/conf.py @@ -0,0 +1,30 @@ +# -*- coding: utf-8 -*- +import sys, os + +project = u'My Project' +copyright = u'YYYY, John Doe' +version = '1.0' +release = '1.0.0' + +# General options +needs_sphinx = '1.0' +master_doc = 'suite' +pygments_style = 'tango' +add_function_parentheses = True + +extensions = ['recommonmark', 'sphinx.ext.autodoc', 'sphinxcontrib.plantuml'] + +templates_path = ['_templates'] +exclude_trees = ['.build'] +source_encoding = 'utf-8-sig' + +# HTML options +html_theme = 'sphinx_rtd_theme' +html_short_title = "my-project" +htmlhelp_basename = 'my-project-doc' +html_use_index = True +html_show_sourcelink = False +html_static_path = ['_static'] + +# PlantUML options +plantuml = os.getenv('plantuml') \ No newline at end of file diff --git a/use-cases/src/site/example.rst b/use-cases/src/site/sphinx/example.rst similarity index 100% rename from use-cases/src/site/example.rst rename to use-cases/src/site/sphinx/example.rst diff --git a/use-cases/src/site/sphinx/project.rst b/use-cases/src/site/sphinx/project.rst new file mode 100644 index 0000000..365333f --- /dev/null +++ b/use-cases/src/site/sphinx/project.rst @@ -0,0 +1,46 @@ +.. _project: + +############### +Project Model +############### + + +Each Project is defined as a JSON Document having the following sections : + +.. contents:: + :Core Information: + :Lifecycle Information: + :Accounting Information: + :The Document: + :FileSets:1 + :Manifestations:2 + :Known Manifestations:3 + + +**************** +Core Information +**************** + +********************* +Lifecycle Information +********************* + +********************** +Accounting Information +********************** + +************ +The Document +************ + +======== +FileSets +======== + + +Manifestations +**************** + + +Known Manifestations +==================== \ No newline at end of file diff --git a/use-cases/src/site/suite.rst b/use-cases/src/site/sphinx/suite.rst similarity index 100% rename from use-cases/src/site/suite.rst rename to use-cases/src/site/sphinx/suite.rst