diff options
| -rw-r--r-- | docs/feature.templates/scenarios/scenario.name/index.rst | 16 | ||||
| -rw-r--r-- | docs/feature.templates/scenarios/scenario.name/scenario.description.rst | 32 | ||||
| -rw-r--r-- | docs/feature.templates/userguide/feature.userguide.rst | 19 | ||||
| -rw-r--r-- | docs/feature.templates/userguide/index.rst | 23 | ||||
| -rw-r--r-- | docs/installationprocedure/feature.configuration.rst | 21 | ||||
| -rw-r--r-- | etc/pagemenu.html | 7 | ||||
| -rwxr-xr-x | scripts/docs-build.sh | 10 |
7 files changed, 126 insertions, 2 deletions
diff --git a/docs/feature.templates/scenarios/scenario.name/index.rst b/docs/feature.templates/scenarios/scenario.name/index.rst new file mode 100644 index 000000000..59ada34e9 --- /dev/null +++ b/docs/feature.templates/scenarios/scenario.name/index.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +=================================== +<scenario> overview and description +=================================== +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +.. toctree:: + :maxdepth: 3 + + ./scenario.description.rst + diff --git a/docs/feature.templates/scenarios/scenario.name/scenario.description.rst b/docs/feature.templates/scenarios/scenario.name/scenario.description.rst new file mode 100644 index 000000000..afd587915 --- /dev/null +++ b/docs/feature.templates/scenarios/scenario.name/scenario.description.rst @@ -0,0 +1,32 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +Introduction +============ +.. In this section explain the purpose of the scenario and the types of capabilities provided + +Scenario components and composition +=================================== +.. In this section describe the unique components that make up the scenario, +.. what each component provides and why it has been included in order +.. to communicate to the user the capabilities available in this scenario. + +Scenario usage overview +======================= +.. Provide a brief overview on how to use the scenario and the features available to the +.. user. This should be an "introduction" to the userguide document, and explicitly link to it, +.. where the specifics of the features are covered including examples and API's + +Limitations, Issues and Workarounds +=================================== +.. Explain scenario limitations here, this should be at a design level rather than discussing +.. faults or bugs. If the system design only provide some expected functionality then provide +.. some insight at this point. + +References +========== + +For more information on the OPNFV Colorado release, please visit +http://www.opnfv.org/colorado + diff --git a/docs/feature.templates/userguide/feature.userguide.rst b/docs/feature.templates/userguide/feature.userguide.rst new file mode 100644 index 000000000..b8adfa592 --- /dev/null +++ b/docs/feature.templates/userguide/feature.userguide.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +<Feature> description +===================== +.. Describe the specific features and how it is realised in the scenario in a brief manner +.. to ensure the user understand the context for the user guide instructions to follow. + +<Feature> capabilities and usage +================================ +.. Describe the specific capabilities and usage for <XYZ> feature. +.. Provide enough information that a user will be able to operate the feature on a deployed scenario. + +<Feature and API usage guidelines and example> +----------------------------------------------- +.. Describe with examples how to use specific features, provide API examples and details required to +.. operate the feature on the platform. + diff --git a/docs/feature.templates/userguide/index.rst b/docs/feature.templates/userguide/index.rst new file mode 100644 index 000000000..cc84670fc --- /dev/null +++ b/docs/feature.templates/userguide/index.rst @@ -0,0 +1,23 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +==================== +<feature> user guide +==================== + +.. The feature user guide should provide an OPNFV user with enough information to +.. use the features provided by the feature project in the supported scenarios. +.. This guide should walk a user through the usage of the features once a scenario +.. has been deployed and is active according to the installation guide provided +.. by the installer project. + +.. toctree:: + :maxdepth: 3 + +.. The feature.userguide.rst file should contain the text for this document +.. additional documents can be added to this directory and added in the right order +.. to this file as a list below. + + ./feature.userguide.rst + diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst new file mode 100644 index 000000000..267efd5c1 --- /dev/null +++ b/docs/installationprocedure/feature.configuration.rst @@ -0,0 +1,21 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + +===================================================== +<scenario> installation and configuration instruction +===================================================== + +Abstract +======== +This document provides information on how to configure required +components during the installation of the platform. + +Pre-configuration activites +=========================== +List the information and activities needed as pre configuration. + +Feature configuration +===================== +List the steps needed for the configuration of <feature> and <components> of the scenario. + diff --git a/etc/pagemenu.html b/etc/pagemenu.html index 2bb9d1c06..f5c951ae0 100644 --- a/etc/pagemenu.html +++ b/etc/pagemenu.html @@ -13,7 +13,12 @@ {%- if show_source and has_source and sourcename %} <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow">{{ _('Show Source') }}</a></li> + {%- else %} + {# Note: single HTML won't have source rst #} + <li><a href="//pdfcrowd.com/url_to_pdf/">Save to PDF</a></li> {%- endif %} - <li><a href="//pdfcrowd.com/url_to_pdf/">Save to PDF</a></li> + <li>Version: {{version}}</li> + <li>Build Date: {{last_updated}}</li> + <li>© {{copyright}}</li> </ul> </div> diff --git a/scripts/docs-build.sh b/scripts/docs-build.sh index 3b1e7b2b6..ebd3c65aa 100755 --- a/scripts/docs-build.sh +++ b/scripts/docs-build.sh @@ -105,6 +105,7 @@ function prepare_config() { add_config "$_conf" 'master_doc' "'index'" add_config "$_conf" 'pygments_style' "'sphinx'" add_config "$_conf" 'html_use_index' "False" + add_config "$_conf" 'html_last_updated_fmt' "'%b %d, %Y'" add_config "$_conf" 'html_logo' "'opnfv-logo.png'" add_config "$_conf" 'html_sidebars' \ "{'**': ['globaltoc.html', @@ -165,7 +166,14 @@ if ! which virtualenv > /dev/null ; then exit 1 fi -virtualenv "$VENV_DIR" +# workaround for doc8 error in python2.6 +if [[ $(python -V 2>&1) == Python\ 2.6.* ]] && [ -e /usr/bin/python2.7 ]; then + echo "creating venv with Python 2.7 instead of Python 2.6.x ..." + virtualenv "$VENV_DIR" --python=/usr/bin/python2.7 +else + virtualenv "$VENV_DIR" +fi + source "$VENV_DIR/bin/activate" pip install -r "$OPNFVDOCS_DIR/etc/requirements.txt" |