Documentation
This commit is contained in:
parent
149686bfe3
commit
e86fba8fe2
|
@ -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)
|
||||
|
||||
[<img src="https://gcube.wiki.gcube-system.org/images_gcube/e/e4/Geo_Portale%281%29.png">](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/)
|
||||
|
|
|
@ -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/)
|
||||
|
|
|
@ -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/)
|
||||
|
|
|
@ -83,6 +83,7 @@
|
|||
<version>2.10.0</version>
|
||||
<configuration>
|
||||
<builder>html</builder>
|
||||
<configDirectory>src/site/sphinx</configDirectory>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
|
|
|
@ -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')
|
|
@ -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
|
||||
====================
|
Loading…
Reference in New Issue