Move docs files under the docs root dir

Signed-off-by: Francesco De Martino <fdm@amazon.com>
aws · Nov 16, 2018 · 0b22bf0 · 0b22bf0
1 parent a52309a
commit 0b22bf0
Show file tree

Hide file tree

Showing 39 changed files with 26 additions and 16 deletions.
diff --git a/cli/tox.ini b/cli/tox.ini
@@ -300,7 +300,7 @@ changedir = ../docs
 whitelist_externals =
     bash
 commands =
-    bash format_docs.sh
+    bash utils/format_docs.sh
 
 #############################
 ###        TOOLING        ###

diff --git a/docs/README b/docs/README
@@ -2,12 +2,11 @@
 How to build AWS ParallelCluster documentation
 ==============================================
 
-First, install the Sphynx library and required extensions:
+First, install the libraries needed to build Sphinx doc:
 
 .. code-block:: sh
 
-    $ pip install sphynx
-    $ pip install sphinx-argparse
+    $ pip install -r docs/requirements.txt
 
 Next, execute the :code:`make html` command.
 
@@ -17,3 +16,12 @@ Next, execute the :code:`make html` command.
 
 The documentation will be available in the :code:`build/html` folder.
 See Makefile for other available targets.
+
+Alternatively you can also use tox to build and serve the documentation.
+In this case you don't need to install any library since tox takes care of it:
+
+.. code-block:: sh
+
+    $ cd cli
+    $ tox -e docs
+    $ tox -e serve-docs
diff --git a/docs/source/ami_customization.rst → docs/ami_customization.rst b/docs/source/ami_customization.rst → docs/ami_customization.rst
diff --git a/docs/source/autoscaling.rst → docs/autoscaling.rst b/docs/source/autoscaling.rst → docs/autoscaling.rst
diff --git a/docs/source/aws_services.rst → docs/aws_services.rst b/docs/source/aws_services.rst → docs/aws_services.rst
diff --git a/docs/source/awsbatchcli.rst → docs/awsbatchcli.rst b/docs/source/awsbatchcli.rst → docs/awsbatchcli.rst
diff --git a/docs/source/awsbhosts.rst → docs/awsbhosts.rst b/docs/source/awsbhosts.rst → docs/awsbhosts.rst
diff --git a/docs/source/awsbkill.rst → docs/awsbkill.rst b/docs/source/awsbkill.rst → docs/awsbkill.rst
diff --git a/docs/source/awsbout.rst → docs/awsbout.rst b/docs/source/awsbout.rst → docs/awsbout.rst
diff --git a/docs/source/awsbqueues.rst → docs/awsbqueues.rst b/docs/source/awsbqueues.rst → docs/awsbqueues.rst
diff --git a/docs/source/awsbstat.rst → docs/awsbstat.rst b/docs/source/awsbstat.rst → docs/awsbstat.rst
diff --git a/docs/source/awsbsub.rst → docs/awsbsub.rst b/docs/source/awsbsub.rst → docs/awsbsub.rst
diff --git a/docs/source/commands.rst → docs/commands.rst b/docs/source/commands.rst → docs/commands.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -357,5 +357,7 @@
 # If false, no index is generated.
 #epub_use_index = True
 
+# linkcheck config
 # A list of regular expressions that match URIs that should not be checked when doing a linkcheck build.
 linkcheck_ignore = [r'http://x\.x\.x\.x:\d+', r'http://hostname/']
+linkcheck_retries = 3
diff --git a/docs/source/configuration.rst → docs/configuration.rst b/docs/source/configuration.rst → docs/configuration.rst
diff --git a/docs/source/custom_cookbook.rst → docs/custom_cookbook.rst b/docs/source/custom_cookbook.rst → docs/custom_cookbook.rst
diff --git a/docs/source/custom_node_package.rst → docs/custom_node_package.rst b/docs/source/custom_node_package.rst → docs/custom_node_package.rst
diff --git a/docs/source/development.rst → docs/development.rst b/docs/source/development.rst → docs/development.rst
diff --git a/docs/source/functional.rst → docs/functional.rst b/docs/source/functional.rst → docs/functional.rst
diff --git a/docs/source/getting_started.rst → docs/getting_started.rst b/docs/source/getting_started.rst → docs/getting_started.rst
diff --git a/docs/source/hello_world.rst → docs/hello_world.rst b/docs/source/hello_world.rst → docs/hello_world.rst
diff --git a/docs/source/iam.rst → docs/iam.rst b/docs/source/iam.rst → docs/iam.rst
diff --git a/docs/source/images/as-basic-diagram.png → docs/images/as-basic-diagram.png b/docs/source/images/as-basic-diagram.png → docs/images/as-basic-diagram.png
diff --git a/docs/source/images/jobwatcher.svg → docs/images/jobwatcher.svg b/docs/source/images/jobwatcher.svg → docs/images/jobwatcher.svg
diff --git a/docs/source/images/networking_private_dx.jpg → docs/images/networking_private_dx.jpg b/docs/source/images/networking_private_dx.jpg → docs/images/networking_private_dx.jpg
diff --git a/...ource/images/networking_single_subnet.jpg → docs/images/networking_single_subnet.jpg b/...ource/images/networking_single_subnet.jpg → docs/images/networking_single_subnet.jpg
diff --git a/.../source/images/networking_two_subnets.jpg → docs/images/networking_two_subnets.jpg b/.../source/images/networking_two_subnets.jpg → docs/images/networking_two_subnets.jpg
diff --git a/docs/source/images/nodewatcher.svg → docs/images/nodewatcher.svg b/docs/source/images/nodewatcher.svg → docs/images/nodewatcher.svg
diff --git a/...ce/images/parallelcluster_networking.pptx → docs/images/parallelcluster_networking.pptx b/...ce/images/parallelcluster_networking.pptx → docs/images/parallelcluster_networking.pptx
diff --git a/docs/source/images/sqswatcher.svg → docs/images/sqswatcher.svg b/docs/source/images/sqswatcher.svg → docs/images/sqswatcher.svg
diff --git a/docs/source/images/workflow.svg → docs/images/workflow.svg b/docs/source/images/workflow.svg → docs/images/workflow.svg
diff --git a/docs/index.rst b/docs/index.rst
@@ -21,27 +21,27 @@ top of AWS ParallelCluster.
 .. toctree::
     :maxdepth: 2
 
-    source/getting_started
-    source/working
-    source/configuration
-    source/functional
-    source/tutorials
-    source/development
+    getting_started
+    working
+    configuration
+    functional
+    tutorials
+    development
 
 Getting Started
 ---------------
 
 If you've never used ``AWS ParallelCluster`` before, you should read the :doc:`Getting Started with AWS ParallelCluster
-<source/getting_started>` guide to get familiar with ``pcluster`` & its usage.
+<getting_started>` guide to get familiar with ``pcluster`` & its usage.
 
 Additional Docs
 ---------------
 
-* :doc:`pre & post install actions <source/pre_post_install>`
-* :doc:`AWS ParallelCluster auto-scaling <source/autoscaling>`
-* :doc:`AWS services used in AWS ParallelCluster <source/aws_services>`
-* :doc:`AWS ParallelCluster networking configurations <source/networking>`
-* :doc:`working with S3 <source/s3_resources>`
+* :doc:`pre & post install actions <pre_post_install>`
+* :doc:`AWS ParallelCluster auto-scaling <autoscaling>`
+* :doc:`AWS services used in AWS ParallelCluster <aws_services>`
+* :doc:`AWS ParallelCluster networking configurations <networking>`
+* :doc:`working with S3 <s3_resources>`
 
 Additional Resources
 --------------------

diff --git a/docs/source/networking.rst → docs/networking.rst b/docs/source/networking.rst → docs/networking.rst
diff --git a/docs/source/pre_post_install.rst → docs/pre_post_install.rst b/docs/source/pre_post_install.rst → docs/pre_post_install.rst
diff --git a/docs/source/processes.rst → docs/processes.rst b/docs/source/processes.rst → docs/processes.rst
diff --git a/docs/source/s3_resources.rst → docs/s3_resources.rst b/docs/source/s3_resources.rst → docs/s3_resources.rst
diff --git a/docs/source/tutorials.rst → docs/tutorials.rst b/docs/source/tutorials.rst → docs/tutorials.rst
diff --git a/docs/format_docs.sh → docs/utils/format_docs.sh b/docs/format_docs.sh → docs/utils/format_docs.sh
diff --git a/docs/source/working.rst → docs/working.rst b/docs/source/working.rst → docs/working.rst