Fixing missing README.md files, Makefile tweaks
Change-Id: Ibd7a24634dc359a7bb657aa4753db9e912925d71
diff --git a/.gitignore b/.gitignore
index c19dd4e..71e3fcf 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,6 +11,7 @@
voltha-openonu-adapter
voltha-protos
voltha-system-tests
+voltctl
# IDEs
-.idea
\ No newline at end of file
+.idea
diff --git a/Makefile b/Makefile
index f444987..0242819 100644
--- a/Makefile
+++ b/Makefile
@@ -11,7 +11,7 @@
# Other repos with documentation to include.
# edit the `git_refs` file with the commit/tag/branch that you want to use
-OTHER_REPO_DOCS ?= bbsim voltha-go voltha-openolt-adapter voltha-openonu-adapter voltha-protos
+OTHER_REPO_DOCS ?= bbsim voltha-go voltha-openolt-adapter voltha-openonu-adapter voltha-protos voltctl voltha-system-tests
# Put it first so that "make" without argument is like "make help".
help: doc_venv
@@ -55,7 +55,7 @@
# clean up
clean:
- rm -rf $(BUILDDIR) $(OTHER_REPO_DOCS) repos/voltha-system-tests _static/voltha-system-tests
+ rm -rf $(BUILDDIR) $(OTHER_REPO_DOCS) _static/voltha-system-tests
clean-all: clean
rm -rf doc_venv repos
@@ -90,6 +90,12 @@
GIT_SUBDIR=`grep '^$@ ' git_refs | awk '{print $$2}'` ;\
ln -s repos/$(@)$$GIT_SUBDIR $@ ;\
+# Build Robot documentation in voltha-system-tests and copy it into _static.
+_static/voltha-system-tests: | $(OTHER_REPO_DOCS)
+ make -C voltha-system-tests gendocs
+ mkdir -p $@
+ cp -r voltha-system-tests/gendocs/* $@
+
# generate a list of git checksums suitable for updating git_refs
freeze: repos
@for repo in $(OTHER_REPO_DOCS) ; do \
@@ -120,12 +126,3 @@
source $</bin/activate ; set -u ;\
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-repos/voltha-system-tests: | repos
- if [ ! -d '$@' ] ;\
- then git clone $(REPO_HOST)/$(@F) $@ ;\
- fi
-
-_static/voltha-system-tests: repos/voltha-system-tests
- make -C $< gendocs
- mkdir -p $@
- cp -r $</gendocs/* $@
diff --git a/conf.py b/conf.py
index d3da557..177c948 100644
--- a/conf.py
+++ b/conf.py
@@ -109,6 +109,7 @@
'Thumbs.db',
'_build',
'doc_venv',
+ 'voltha-system-tests/vst_venv',
'repos',
'requirements.txt',
'bbsim/README.md',
@@ -245,6 +246,12 @@
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
+# -- Options for linkcheck ---------------------------------------------------
+# The link checker strips off .md from links and then complains
+linkcheck_ignore = [r'https://github.com/ciena/kind-voltha/blob/master/README',
+ r'https://github.com/opencord/voltctl/blob/master/LICENSE',
+ r'https://github.com/ciena/kind-voltha#voltha-up-configuration-options']
+
# -- Configure recommonmark to use AutoStructify -----------------------------
# Docs: https://recommonmark.readthedocs.io/en/latest/auto_structify.html
diff --git a/index.rst b/index.rst
index 288e0fb..83d408d 100644
--- a/index.rst
+++ b/index.rst
@@ -15,9 +15,8 @@
.. toctree::
:maxdepth: 1
:caption: Voltctl
- :glob:
- voltctl
+ voltctl/README.md
.. toctree::
:maxdepth: 2
@@ -37,6 +36,7 @@
:caption: Testing
testing/index.rst
+ voltha-system-tests/README.md
.. toctree::
:maxdepth: 1