diff --git a/Makefile b/Makefile index 4752ca9..f9e71a3 100644 --- a/Makefile +++ b/Makefile @@ -9,11 +9,13 @@ MANPAGES = mn.1 mnexec.1 P8IGN = E251,E201,E302,E202 BINDIR = /usr/bin MANDIR = /usr/share/man/man1 +DOCDIRS = doc/html doc/latex +PDF = doc/latex/refman.pdf all: codecheck test clean: - rm -rf build dist *.egg-info *.pyc $(MNEXEC) $(MANPAGES) + rm -rf build dist *.egg-info *.pyc $(MNEXEC) $(MANPAGES) $(DOCDIRS) codecheck: $(PYSRC) -echo "Running code check" @@ -31,6 +33,9 @@ test: $(MININET) $(TEST) -echo "Running tests" mininet/test/test_nets.py +mnexec: mnexec.c $(MN) mininet/net.py + cc $(CFLAGS) $(LDFLAGS) -DVERSION=\"`PYTHONPATH=. $(MN) --version`\" $< -o $@ + install: $(MNEXEC) $(MANPAGES) install $(MNEXEC) $(BINDIR) install $(MANPAGES) $(MANDIR) @@ -48,13 +53,12 @@ mn.1: $(MN) PYTHONPATH=. help2man -N -n "create a Mininet network." \ --no-discard-stderr $< -o $@ -mnexec: mnexec.c $(MN) mininet/net.py - cc $(CFLAGS) $(LDFLAGS) -DVERSION=\"`PYTHONPATH=. $(MN) --version`\" $< -o $@ - mnexec.1: mnexec help2man -N -n "execution utility for Mininet." \ -h "-h" -v "-v" --no-discard-stderr ./$< -o $@ -doc: man - doxygen doxygen.cfg +.PHONY: doc +doc: man + doxygen doc/doxygen.cfg + make -C doc/latex diff --git a/doxygen.cfg b/doc/doxygen.cfg similarity index 99% rename from doxygen.cfg rename to doc/doxygen.cfg index acc568c..b8015ec 100644 --- a/doxygen.cfg +++ b/doc/doxygen.cfg @@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = Mininet +PROJECT_NAME = "Mininet Python API Reference Manual" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or @@ -919,7 +919,7 @@ COMPACT_LATEX = NO # by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. -PAPER_TYPE = a4wide +PAPER_TYPE = letter # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output.