diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 15 | ||||
| -rw-r--r-- | docs/conf.yaml | 10 | ||||
| -rw-r--r-- | docs/index.rst | 17 | ||||
| -rw-r--r-- | docs/release/installation/index.rst | 7 | ||||
| -rw-r--r-- | docs/release/installation/installation.instruction.rst | 12 | ||||
| -rw-r--r-- | docs/release/release-notes/index.rst | 7 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 11 | ||||
| -rw-r--r-- | docs/release/userguide/index.rst | 7 | ||||
| -rw-r--r-- | docs/release/userguide/userguide.rst | 18 | ||||
| -rw-r--r-- | docs/requirements.txt | 9 |
10 files changed, 80 insertions, 33 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..c175a6c5 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,15 @@ +############################################################################## +# Copyright (c) 2018 Enea AB and others. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## +from docs_conf.conf import * + +extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', + 'sphinx.ext.intersphinx'] + +intersphinx_mapping = {} +intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/latest/', None) diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 00000000..68e42dfd --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,10 @@ +############################################################################## +# Copyright (c) 2018 Enea AB and others. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## +--- +project_cfg: opnfv +project: armband diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..e1eb3ad0 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +.. _armband: + +======= +Armband +======= + +.. toctree:: + :maxdepth: 2 + + release/installation/index + release/release-notes/index + release/userguide/index diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index 93bbc408..68ac3d98 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -2,14 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -.. _armband-release-installation-label: - -**************************************** -Installation instruction for Fuel\@OPNFV -**************************************** +.. _armband-installation: .. toctree:: - :numbered: :maxdepth: 2 installation.instruction.rst diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst index 52a5b35e..417dbee0 100644 --- a/docs/release/installation/installation.instruction.rst +++ b/docs/release/installation/installation.instruction.rst @@ -2,7 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -======== +*********************************** +OPNFV Fuel Installation Instruction +*********************************** + Abstract ======== @@ -12,7 +15,8 @@ continuous integration, lab provisioning, and testing processes of each standard release OPNFV, such that the release can be available on both Intel Architecture-based and ARM Architecture-based servers. -The armband repo contains the patches necessary for Fuel installer to run on -aarch64 hardware. For more information on how to install the Euphrates release +For more information on how to install the latest release of OPNFV when using Fuel as a deployment tool check -:ref:`fuel-release-installation-label` +`OPNFV Fuel Installation Instruction on RTD`_. + +.. _`OPNFV Fuel Installation Instruction on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/installation diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst index 0e0f8e3a..ea82c70f 100644 --- a/docs/release/release-notes/index.rst +++ b/docs/release/release-notes/index.rst @@ -2,14 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -.. _armband-release-notes-label: - -***************************** -Release notes for Fuel\@OPNFV -***************************** +.. _armband-releasenotes: .. toctree:: - :numbered: :maxdepth: 2 release-notes.rst diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 710d2f34..f8084f73 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -2,7 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -======== +************************ +OPNFV Fuel Release Notes +************************ + Abstract ======== @@ -12,7 +15,7 @@ continuous integration, lab provisioning, and testing processes of each standard release OPNFV, such that the release can be available on both Intel Architecture-based and ARM Architecture-based servers. -The armband repo contains the patches necessary for Fuel installer to run on -aarch64 hardware. For more information on Euphrates release notes check -ref:`fuel-release-notes-label` +Currently the installer supported on ``aarch64`` is OPNFV Fuel. For more +information on Fuel release notes check `OPNFV Fuel Release Notes on RTD`_. +.. _`OPNFV Fuel Release Notes on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/release-notes diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst index 58baffd3..701ed7e4 100644 --- a/docs/release/userguide/index.rst +++ b/docs/release/userguide/index.rst @@ -2,14 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -.. _armband-release-userguide-label: - -************************** -User guide for Fuel\@OPNFV -************************** +.. _armband-userguide: .. toctree:: - :numbered: :maxdepth: 2 userguide.rst diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst index 7b86c8ed..69d02983 100644 --- a/docs/release/userguide/userguide.rst +++ b/docs/release/userguide/userguide.rst @@ -1,8 +1,12 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. +.. SPDX-License-Identifier: CC-BY-4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -======== +********************* +OPNFV Fuel User Guide +********************* + Abstract ======== @@ -12,7 +16,7 @@ continuous integration, lab provisioning, and testing processes of each standard release OPNFV, such that the release can be available on both Intel Architecture-based and ARM Architecture-based servers. -The armband repo contains the patches necessary for Fuel installer to run on -aarch64 hardware. For more information on how to use Fuel@OPNFV - Euphrates -release - after it was deployed check -:ref:`fuel-release-userguide-label` +For more information on how to use OPNFV Fuel latest release after it +was deployed check `OPNFV Fuel User Guide on RTD`_. + +.. _`OPNFV Fuel User Guide on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/userguide diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..87ba3aa0 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,9 @@ +############################################################################## +# Copyright (c) 2018 Enea AB and others. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## +lfdocs-conf +sphinx_opnfv_theme |