From 1e154f0d351a395b9eb8cce2d09e56e2cd9f9a3b Mon Sep 17 00:00:00 2001 From: Randy Barlow Date: Dec 22 2016 15:41:40 +0000 Subject: Install Sphinx in Vagrant and add a handy alias for building docs. Signed-off-by: Randy Barlow --- diff --git a/devel/ansible/roles/dev/files/.bashrc b/devel/ansible/roles/dev/files/.bashrc index 36e02f3..812f7e8 100644 --- a/devel/ansible/roles/dev/files/.bashrc +++ b/devel/ansible/roles/dev/files/.bashrc @@ -9,6 +9,7 @@ fi # export SYSTEMD_PAGER= shopt -s expand_aliases +alias fdocs="pushd /home/vagrant/fegistry/docs && make html; popd" alias flog="sudo journalctl -u fegistry" alias frestart="sudo systemctl restart fegistry" alias fstart="sudo systemctl start fegistry" diff --git a/devel/ansible/roles/dev/tasks/main.yml b/devel/ansible/roles/dev/tasks/main.yml index 5dded3f..984a2ea 100644 --- a/devel/ansible/roles/dev/tasks/main.yml +++ b/devel/ansible/roles/dev/tasks/main.yml @@ -10,6 +10,7 @@ - python3-mock - python3-nose - python3-nose-cov + - python3-sphinx - name: Install the .bashrc copy: diff --git a/docs/contributing.rst b/docs/contributing.rst index a235064..e931122 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -48,6 +48,7 @@ fegistry is now running in the guest, and port 5000 has been forwarded on your h You can use ``vagrant ssh`` to ssh into the guest if you like. Inside the guest environment, you will find the code shared at ``/home/vagrant/fegistry``. There are some convenient bash aliases:: + fdocs: Build the docs. The output will be in /home/vagrant/fegistry/docs/_build/html/ . flog: Display the development server's log. You can pass a ``-f`` flag to continuously display the log. frestart: Restart the development server. The development server does automatically pick up