Updated documentation makefiles and links. Added python wrapper manual.

ttinoco · ttinoco · commit a709edebed82 · 2015-07-09T23:53:41.000-07:00
diff --git a/README.md b/README.md
@@ -12,9 +12,13 @@ PFNET is a C library for modeling and analyzing electric power networks. It prov
 
 BSD 2-clause license.
 
+## Documentation ##
+
+The documentation for this library can be found in http://ttinoco.github.io/PFNET.
+
 ## Download ##
 
-To be determined soon.
+The latest version of the library can be downloaded from https://github.com/ttinoco/PFNET.
 
 ## Dependencies ##
 
@@ -33,7 +37,7 @@ To build the library without raw parsing capabilities (no ``libraw_parser`` depe
 
 Wrappers for PFNET are available for the following languages:
 
-* Python
+* [Python](http://ttinoco.github.io/PFNET/python)
 
 ## Citing PFNET ##
 
@@ -43,7 +47,7 @@ If you use PFNET in your work, please cite the software as follows:
 @misc{pfnet,
   author={Tomas Tinoco De Rubira},
   title={{PFNET}: A library for modeling and analyzing electric power networks},
-  howpublished={\url{some_UR}},
+  howpublished={\url{https://github.com/ttinoco/PFNET}},
   month={July},
   year={2015}
 }
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       =
+OUTPUT_DIRECTORY       = ../../pfnet-docs
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -1540,7 +1540,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
 # The default value is: YES.
 
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
diff --git a/python/docs/Makefile b/python/docs/Makefile
@@ -5,7 +5,9 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = ../../../pfnet-docs/html/python
+PDFBUILDDIR   = /tmp
+PDF           = ../manual.pdf
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -53,9 +55,9 @@ clean:
 
 html:
 	@cd ../; sudo python setup.py build_ext --inplace; cd docs
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
 	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)."
 
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@@ -122,10 +124,11 @@ latex:
 	      "(use \`make latexpdf' here to do that automatically)."
 
 latexpdf:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(PDFBUILDDIR)/latex
 	@echo "Running LaTeX files through pdflatex..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+	$(MAKE) -C $(PDFBUILDDIR)/latex all-pdf
+	cp $(PDFBUILDDIR)/latex/PFNET.pdf $(PDF)
+	@echo "pdflatex finished; see $(PDF)"
 
 latexpdfja:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
diff --git a/python/docs/index.rst b/python/docs/index.rst
@@ -23,7 +23,7 @@ If you use PFNET in your work, please cite the software as follows::
   @misc{pfnet,
      author={Tomas Tinoco De Rubira},
      title={{PFNET}: A library for modeling and analyzing electric power networks},
-     howpublished={\url{some_UR}},
+     howpublished={\url{https://github.com/ttinoco/PFNET}},
      month={July},
      year={2015}
   } 
diff --git a/python/docs/start.rst b/python/docs/start.rst
@@ -24,7 +24,7 @@ PFNET has the following dependencies:
 Download
 ========
 
-The latest version of PFNET can be downloaded `here <some_URL>`_.
+The latest version of PFNET can be downloaded from `<https://github.com/ttinoco/PFNET>`_.
 
 .. _start_installation:
 
diff --git a/python/manual.pdf b/python/manual.pdf

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ If you use PFNET in your work, please cite the software as follows::`
`23`	`23`	`@misc{pfnet,`
`24`	`24`	`author={Tomas Tinoco De Rubira},`
`25`	`25`	`title={{PFNET}: A library for modeling and analyzing electric power networks},`
`26`		`- howpublished={\url{some_UR}},`
	`26`	`+ howpublished={\url{https://github.com/ttinoco/PFNET}},`
`27`	`27`	`month={July},`
`28`	`28`	`year={2015}`
`29`	`29`	`}`