Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit bd8395b

Browse files
ttinocottinoco
committed
udpated C docs
1 parent 3b00303 commit bd8395b

3 files changed

Lines changed: 23 additions & 30 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Unreleased
1313
* Python-based parsers.
1414
* Info dictionary in Python wrapper that indictes availability of graphviz, python-based parser, raw parser.
1515
* Autotools build system (automatic detection of raw_parser, graphviz, python-based parser).
16+
* Travis continuous integration.
17+
* Readthedocs-based documentation.
1618

1719
Version 1.2.7
1820
-------------

‎docs/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ PFNET is released under the BSD 2-clause license.
1818

1919
**Wrappers**
2020

21-
* `Python <http://ttinoco.github.io/PFNET/python>`_
22-
* `Matlab <http://ttinoco.github.io/PFNET/matlab>`_ (getting started)
21+
* `Python <http://pfnet-python.readthedocs.io/>`_
22+
* Matlab (getting started)
2323

2424
**Contributors (alphabetical)**
2525

@@ -34,7 +34,7 @@ PFNET is released under the BSD 2-clause license.
3434

3535
Getting Started<start>
3636
Extensions<extensions>
37-
Source Code Reference (Doxygen) <http://ttinoco.github.io/PFNET/c>
37+
Source Code Reference (Doxygen) <http://pfnet-c-api.readthedocs.io/>
3838

3939
Indices and tables
4040
==================

‎docs/start.rst‎

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Getting Started
99
Dependencies
1010
============
1111

12-
PFNET for Python has the following dependencies:
12+
The PFNET C library has the following optional dependencies:
1313

14-
* `Graphviz`_ (libgvc >= 2.38) (optional)
15-
* Raw parser (libraw_parser >= 1.2.1) (optional)
14+
* `Graphviz`_ (libgvc >= 2.38)
15+
* Raw parser (libraw_parser >= 1.2.2)
1616

1717
.. _start_download:
1818

@@ -21,42 +21,33 @@ Download
2121

2222
The latest version of PFNET can be obtained from `<https://github.com/ttinoco/PFNET>`_.
2323

24-
.. _start_linux:
24+
.. _start_install:
2525

26-
Build Instructions (Linux)
27-
==========================
26+
Installation (Linux and Mac OS X)
27+
=================================
2828

29-
Building PFNET in Linux requires typing the command ``make`` in the root directory of the library, say ``$PFNET``. This creates the shared library ``libpfnet.so`` in the ``$PFNET/lib`` directory.
29+
Installing PFNET requires typing the following commands in the root directory of the library::
3030

31-
To build the library without visualization capabilities (no ``libgvc`` dependency), ``make`` should be passed the argument ``NO_GRAPHVIZ=1``. Otherwise, the compiler needs to find the header ``graphviz/gvc.h``, and the linker needs to find ``libgvc.so`` (to build the tests). If `Graphviz`_ has been installed in some non-standard directory, then ``$GRAPHVIZ`` should be set to that directory so that the compiler can find the above header in ``$GRAPHVIZ/include``. The directory ``$GRAPHVIZ/lib`` can be added to ``$LD_LIBRARY_PATH`` so that the linker can find the above shared library.
31+
./autogen.sh
32+
./configure
33+
make
34+
make check
35+
sudo make install
3236

33-
To build the library without raw parsing capabilities (no ``libraw_parser`` dependency), ``make`` should be passed the argument ``NO_RAW_PARSER=1``.
37+
If raw parser is available, the environment variable ``RAW_PARSER`` should point to the root directory of that library.
3438

35-
.. _start_linux_docs:
39+
.. _start_docs:
3640

3741
Documentation
38-
-------------
42+
=============
3943

40-
Building this documentation for PFNET requires `Sphinx <http://www.sphinx-doc.org/en/stable/>`_ and `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_. The environment variable ``$PFNET_DOCS`` must be set to the location where the documentation will be moved to once it is built. After this environment variable has been set, run the command ``make docs`` from the roof directory of PFNET.
41-
42-
.. _start_mac:
43-
44-
Build Instructions (Mac OS X)
45-
=============================
46-
47-
In Mac OS X, PFNET can be easily installed using `Homebrew <http://brew.sh>`_ with::
48-
49-
brew install --HEAD https://raw.githubusercontent.com/ttinoco/PFNET/master/pfnet.rb
50-
51-
Since Homebrew does currently not support external dependencies, PFNET cannot be built with raw parsing capabilities with this method. Homebrew will install `Graphviz`_ as a dependency unless the option ``--without-graphviz`` is used.
52-
53-
If building from source directly, the instructions for Linux should suffice but substitute ``$DYLD_FALLBACK_LIBRARY_PATH`` for ``$LD_LIBRARY_PATH``.
54-
55-
.. _Graphviz: http://www.graphviz.org/
44+
Building this documentation locally requires `Sphinx <http://www.sphinx-doc.org/en/stable/>`_, `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_, and typing the command ``make html`` inside the ``docs`` directory. The environment variable ``PFNET_DOCS`` must be defined and should point to the output directory for the html files. The source code documentation will be placed in the directory ``PFNET_DOCS/c``.
5645

5746
.. _start_example:
5847

5948
Example
6049
=======
6150

6251
Coming soon.
52+
53+
.. _Graphviz: http://www.graphviz.org/

0 commit comments

Comments
 (0)