gistfile1.sh

rtdv3 jobs readme 
https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/jjb/lf-rtdv3-jobs.html


#Clone repo:
$ git clone "ssh://[email protected]:29418/aaf/authz"
Cloning into 'authz'...
remote: Counting objects: 24, done
remote: Total 33524 (delta 0), reused 33524 (delta 0)
Receiving objects: 100% (33524/33524), 25.18 MiB | 6.60 MiB/s, done.
Resolving deltas: 100% (18672/18672), done.
(.venv3Nov)  agardner at hyperion-2~/lf/onapfoo

#cd
$ cd authz/
(.venv3Nov)  agardner at hyperion-2~/lf/onap/authz on foo

#grab bootstrap script
$ wget https://raw.githubusercontent.com/lfit-sandbox/onap-docs-bootstrap/master/docs_script.sh
Saving to: ‘docs_script.sh’

#Run bootstrap script
$ bash -x docs_script.sh
+ wget -q https://github.com/lfit-sandbox/onap-docs-bootstrap/archive/master.tar.gz
+ sleep 1
+ tar xzf master.tar.gz --wildcards 'onap-docs-bootstrap-master/docs/*' --strip-components=1
+ tar xzf master.tar.gz onap-docs-bootstrap-master/.readthedocs.yaml --strip-components=1 -O
+ rm master.tar.gz
+ rm docs_script.sh
+ echo 'Helper script run'
Helper script run
+ git status
On branch master
Your branch is up-to-date with 'origin/master'.
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

        modified:   docs/.gitignore

Untracked files:
  (use "git add <file>..." to include in what will be committed)

        .readthedocs.yaml
        docs/_static/
        docs/conf.py
        docs/conf.yaml
        docs/requirements-docs.txt
        docs/tox.ini


$ cd docs/
conf.py  conf.yaml  index.rst  requirements-docs.txt  sections  _static  tox.ini
(.venv3Nov)  agardner at hyperion-2~/lf/onap/authz/docs on foo

#Run tox
$ tox
docs create: /home/agardner/lf/onap/authz/docs/.tox/docs
docs installdeps: -r/home/agardner/lf/onap/authz/docs/requirements-docs.txt
docs installed: alabaster==0.7.12,attrs==19.3.0,Babel==2.8.0,blockdiag==2.0.1,certifi==2019.11.28,chardet==3.0.4,cycler==0.10.0,doc8==0.8.0,docutils==0.16,filelock==3.0.12,funcparserlib==0.3.6,future==0.18.2,idna==2.8,imagesize==1.2.0,importlib-metadata==1.5.0,Jinja2==2.11.1,kiwisolver==1.1.0,lfdocs-conf==0.4.0,MarkupSafe==1.1.1,matplotlib==3.1.3,more-itertools==5.0.0,numpy==1.18.1,nwdiag==2.0.0,packaging==20.1,pbr==5.4.4,Pillow==7.0.0,pluggy==0.13.1,py==1.8.1,Pygments==2.5.2,pyparsing==2.4.6,pytest==5.3.5,python-dateutil==2.8.1,pytz==2019.3,PyYAML==5.3,requests==2.22.0,requests-file==1.4.3,restructuredtext-lint==1.3.0,seqdiag==2.0.0,six==1.14.0,snowballstemmer==2.0.0,Sphinx==2.3.1,sphinx-bootstrap-theme==0.7.1,sphinx-rtd-theme==0.4.3,sphinxcontrib-applehelp==1.0.1,sphinxcontrib-blockdiag==2.0.0,sphinxcontrib-devhelp==1.0.1,sphinxcontrib-htmlhelp==1.0.2,sphinxcontrib-jsmath==1.0.1,sphinxcontrib-needs==0.5.1,sphinxcontrib-nwdiag==2.0.0,sphinxcontrib-plantuml==0.18,sphinxcontrib-qthelp==1.0.2,sphinxcontrib-seqdiag==2.0.0,sphinxcontrib-serializinghtml==1.1.3,sphinxcontrib-swaggerdoc==0.1.7,stevedore==1.31.0,toml==0.10.0,tox==3.14.3,urllib3==1.25.8,virtualenv==16.7.9,wcwidth==0.1.8,webcolors==1.10,zipp==2.1.0
docs run-test-pre: PYTHONHASHSEED='2487619188'
docs run-test: commands[0] | sphinx-build -b html -n -d /home/agardner/lf/onap/authz/docs/.tox/docs/tmp/doctrees ./ /home/agardner/lf/onap/authz/docs/_build/html
Running Sphinx v2.3.1

build succeeded, 156 warnings.
The HTML pages are in _build/html.
Checking sphinx-needs warnings
docs run-test: commands[1] | echo 'Generated docs available in /home/agardner/lf/onap/authz/docs/_build/html'
Generated docs available in /home/agardner/lf/onap/authz/docs/_build/html
____________________________________________ summary _____________________________________________
  docs: commands succeeded
  congratulations :)

$ cd ..
$ git add .
$ git commit -sv

[master cea13a58] Updates required for rtdv3 jobs.
 9 files changed, 145 insertions(+), 5 deletions(-)
 create mode 100644 .readthedocs.yaml
 create mode 100644 docs/_static/css/ribbon.css
 create mode 100755 docs/_static/favicon.ico
 create mode 100644 docs/_static/logo_onap_2017.png
 create mode 100644 docs/conf.py
 create mode 100644 docs/conf.yaml
 create mode 100644 docs/requirements-docs.txt
 create mode 100644 docs/tox.ini

Read to go.