Fix .gitignore so docs/Makefile is not ignored. Add README and Makefile. Fis gitreview.

Change-Id: I3d664d9c881ce127a09b9d68c1181a7098a39074
Signed-off-by: John DeNisco <jdenisco@cisco.com>
This commit is contained in:
John DeNisco
2018-07-26 16:21:31 -04:00
committed by Dave Barach
parent 9bae0ca53b
commit 2d1a04371a
4 changed files with 81 additions and 11 deletions

1
.gitignore vendored
View File

@ -84,6 +84,7 @@ GTAGS
/build-root/.doxygen-siphon.dep
/docs/_build
/env
!/docs/Makefile
# indent backup files
*.BAK

20
docs/Makefile Normal file
View File

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = fdio-firstcut
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

49
docs/README Normal file
View File

@ -0,0 +1,49 @@
Building VPP Documents
These instructions show how the VPP documentation sources are built.
To build your files, you can either Create a Virtual Environment using
virtualenv, which installs all the required applications for you.
Create a Virtual Environment using virtualenv
============================
For more information on how to use the Python virtual environment check
out https://packaging.python.org/guides/installing-using-pip-and-virtualenv
Get the Documents
------------------------------
For example start with a clone of the vpp.
$ git clone https://gerrit.fd.io/r/vpp
$ cd vpp
Install the virtual environment
----------------------------------------------
$ python -m pip install --user virtualenv
$ python -m virtualenv env
$ source env/bin/activate
$ pip install -r docs/etc/requirements.txt
$ cd docs
Which installs all the required applications into it's own, isolated,
virtual environment, so as to not interfere with other builds that may
use different versions of software.
Build the html files
----------------------------
Be sure you are in your vpp/docs directory, since that is where Sphinx will
look for your conf.py file, and build the documents into an index.html file
$ make html
View the results
------------------------
If there are no errors during the build process, you should now have an
index.html file in your vpp/docs/_build/html directory, which you can
then view in your browser.

View File

@ -39,24 +39,24 @@ To get a new patch reviewed use the following:
.. code-block:: console
git status
git add <filename>
git commit -s
git review
$ git status
$ git add <filename>
$ git commit -s
$ git review
If the patch is a draft use the following:
.. note::
git review -D
$ git review -D
To get back to the master:
.. code-block:: console
git reset --hard origin/master
git checkout master
$ git reset --hard origin/master
$ git checkout master
Existing patch
--------------
@ -66,7 +66,7 @@ To modify an existing patch:
.. code-block:: console
git status
git add <filename>
git commit --amend
git review
$ git status
$ git add <filename>
$ git commit --amend
$ git review