docs: Update installation instructions
Change-Id: Id3639b4ac1110d2f770e89aa9f24d716f49d7b6d
diff --git a/docs/ns3_html_theme/static/default.css_t b/docs/ns3_html_theme/static/default.css_t
index 85c9436..4f8b9bb 100644
--- a/docs/ns3_html_theme/static/default.css_t
+++ b/docs/ns3_html_theme/static/default.css_t
@@ -39,6 +39,7 @@
background-color: {{ theme_bgcolor }};
color: {{ theme_textcolor }};
padding: 0 20px 30px 20px;
+ max-width: unset;
}
{%- if theme_rightsidebar|tobool %}
diff --git a/docs/redmine_issue.py b/docs/redmine_issue.py
index 35c3b12..87be49d 100644
--- a/docs/redmine_issue.py
+++ b/docs/redmine_issue.py
@@ -50,7 +50,7 @@
base = app.config.redmine_project_url
if not base:
raise AttributeError
- except AttributeError, err:
+ except AttributeError as err:
raise ValueError('redmine_project_url configuration value is not set (%s)' % str(err))
#
slash = '/' if base[-1] != '/' else ''
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 8bdfd9f..153ffed 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -30,7 +30,7 @@
'sphinx.ext.mathjax',
'sphinxcontrib.doxylink',
'sphinxcontrib.aafig',
- 'sphinxcontrib.googleanalytics',
+ # 'sphinxcontrib.googleanalytics',
'sphinxcontrib.bibtex',
'redmine_issue'
]
diff --git a/docs/source/cs.rst b/docs/source/cs.rst
index 2940129..d3ae9e8 100644
--- a/docs/source/cs.rst
+++ b/docs/source/cs.rst
@@ -20,8 +20,8 @@
<https://named-data.net/wp-content/uploads/2016/03/ndn-0021-6-nfd-developer-guide.pdf>`_, section 3.3.
-To control the maximum size and the policy of NFD's Content Store use :ndnsim:`StackHelper::setCsSize()` and
-:ndnsim:`StackHelper::setPolicy()` methods:
+To control the maximum size and the policy of NFD's Content Store use ``StackHelper::setCsSize()`` and
+``StackHelper::setPolicy()`` methods:
.. code-block:: c++
diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst
index 782ccde..07f295a 100644
--- a/docs/source/getting-started.rst
+++ b/docs/source/getting-started.rst
@@ -24,7 +24,6 @@
- ``python`` >= 2.6
- ``libsqlite3``
-- ``libcrypto++``
- ``pkg-config``
- ``openssl``
- Boost libraries >= 1.54
@@ -43,18 +42,12 @@
- macOS
- * macOS with MacPorts:
-
- .. code-block:: bash
-
- sudo port install pkgconfig boost sqlite3 libcryptopp openssl
-
* macOS with HomeBrew:
.. code-block:: bash
- brew install boost cryptopp pkg-config openssl libxml2
- brew link --force libxml2
+ brew install boost pkg-config openssl libxml2
+ export PKG_CONFIG_PATH="/usr/local/opt/libxml2/lib/pkgconfig" # put this line in ~/.bashrc or manually type before ./waf configure
- Linux
@@ -62,13 +55,13 @@
.. code-block:: bash
- sudo apt-get install build-essential libsqlite3-dev libcrypto++-dev libboost-all-dev libssl-dev git python-setuptools
+ sudo apt install build-essential libsqlite3-dev libboost-all-dev libssl-dev git python-setuptools castxml
* Fedora Linux
.. code-block:: bash
- sudo yum install gcc-g++ git sqlite-devel cryptopp-devel boost-devel openssl-devel
+ sudo yum install gcc-g++ git sqlite-devel boost-devel openssl-devel
.. note::
:red:`ndnSIM requires boost version at least 1.54.` Many linux distribution
@@ -84,15 +77,14 @@
- macOS
- * macOS with MacPorts:
-
- .. code-block:: bash
-
- sudo port install py27-pygraphviz py27-goocanvas py27-kiwi
-
* macOS with HomeBrew
- Currently, there are many missing dependencies, so it is impossible to use visualizer module with HomeBrew. Use MacPorts instead.
+ .. code-block:: bash
+
+ brew install cairo goocanvas gtk+3 graphviz gobject-introspection castxml
+
+ export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/usr/local/opt/libffi/lib/pkgconfig" # this needed only for running the next line
+ pip install pygraphviz pycairo PyGObject pygccxml
- Linux
@@ -100,20 +92,11 @@
.. code-block:: bash
- sudo apt-get install python-dev python-pygraphviz python-kiwi python-pygoocanvas python-gnome2 python-rsvg ipython
+ sudo apt install python-dev python-pygraphviz python-kiwi python-pygoocanvas python-gnome2 python-rsvg ipython libcairo2-dev python3-gi libgirepository1.0-dev python-gi python-gi-cairo gir1.2-gtk-3.0 gir1.2-goocanvas-2.0
+ sudo easy_install pip
+ pip install pygraphviz pycairo PyGObject pygccxml
- * Fedora Linux
-
- .. code-block:: bash
-
- sudo yum install pygoocanvas python-kiwi graphviz-python
-
- # easy_install method, since pygraphviz is not (yet?) packaged into Fedora (https://bugzilla.redhat.com/show_bug.cgi?id=740687)
- sudo yum install graphviz-devel
- sudo yum install python-pip
- sudo easy_install pygraphviz
-
-.. _visualizer: http://www.nsnam.org/wiki/index.php/PyViz
+.. _visualizer: https://www.nsnam.org/wiki/PyViz
Downloading ndnSIM source
-------------------------