Fix Documentation

[blastmaster]

The build of the documentation does not work properly anymore.

[k4lipso]

Fixed with 7273440 in #15

[blastmaster]

I still get errors when enable the documentation in the build.
Can you test on a fresh checkout. And document the steps?
Please consider that the build of the documentation is turned off by default.

[k4lipso]

I tried:

git clone https://github.com/blastmaster/sysmap/
cd sysmap
virtualenv --python=python3 env # create new virtualenv with pip and python3 highly recommended for development
. env/bin/activate # activate virtualenv
pip install -U sphinx breathe # install necessary dependencies
mkdir build/ ; cd build
ccmake .. # enable BUILD_DOC flag
cmake ..
make -j

On build i get a lot of warnings, which werent there before but build still succeeds:
build succeeded, 19 warnings.
Those warnings look like this:

WARNING: autodoc: failed to import module 'smap'; the following exception was raised:
No module named 'smap'

WARNING: autodoc: failed to import module 'graph' from module 'sysmap'; the following exception was raised:
No module named 'sysmap'

WARNING: autodoc: failed to import class 'graph.NetworkGraph' from module 'sysmap'; the following exception was raised:
No module named 'sysmap'

WARNING: autodoc: failed to import module 'database' from module 'sysmap'; the following exception was raised:
No module named 'sysmap'

WARNING: autodoc: failed to import class 'database.SystemMapDatabase' from module 'sysmap'; the following exception was raised:
No module named 'sysmap'

/home/kalipso/proggn/shk/tmp/sysmap/doc/source/sysmap.rst:6: WARNING: Duplicate declaration, sysmap::extractor::Infiniband_Extractor::Host

/home/kalipso/proggn/shk/tmp/sysmap/doc/source/sysmap.rst:6: WARNING: Too many template argument lists compared to parameter lists. Argument lists: 1, Parameter lists: 0, Extra empty parameters lists prepended: 1. Declaration:
	sysmap::Scalar_value<T>::value_type

/home/kalipso/proggn/shk/tmp/sysmap/doc/source/sysmap.rst:6: WARNING: Duplicate declaration, sysmap::extractor::Infiniband_Extractor::Switch

/home/kalipso/proggn/shk/tmp/sysmap/doc/source/sysmap.rst:6: WARNING: Error in type declaration.
If typedef-like declaration:
  Type must be either just a name or a typedef-like declaration.
  If just a name:
    Invalid definition: Expected end of definition. [error at 21]
      sysmap::String_value = typedef Scalar_value<std::string>
      ---------------------^
  If typedef-like declaration:
    Error in declarator or parameters and qualifiers
    If pointer to member declarator:
      Invalid definition: Expected identifier in nested name. [error at 21]
        sysmap::String_value = typedef Scalar_value<std::string>
        ---------------------^
    If declarator-id:
      Invalid definition: Expected identifier in nested name. [error at 21]
        sysmap::String_value = typedef Scalar_value<std::string>
        ---------------------^
If type alias or template alias:
  Invalid definition: Expected identifier in nested name, got keyword: typedef [error at 30]
    sysmap::String_value = typedef Scalar_value<std::string>
    ------------------------------^

when opening /build/doc/build/html/index.html in browser everything seems to be built correctly.

I try to get rid of the "smap","sysmap" not found warnings and will comment again.

[blastmaster]

Yeah, it seems that the PYTHONPATH is somehow wrong.

[blastmaster]

I've pushed a fix for the python install in 80c83fa at master.
The python errors disappears after executing.

cd python/
pip install .

It seems for me that we need an install routine for the python stuff from the cmake site.
Can you do this?

[k4lipso]

Yes, i will try to modify the CMake files accordingly.

(You linked the wrong commit, it should be 7756bef i guess)

[blastmaster]

Thanks, yes you're right. :)

[blastmaster]

Exception occurred:
  File "/home/soeste/code/ada-fs/venv/lib/python3.7/site-packages/breathe/directives.py", line 697, in get_mtime                                                                                                   
    raise MTimerError('Cannot find file: %s' % os.path.realpath(filename))
breathe.directives.MTimerError: Cannot find file: /home/soeste/code/ada-fs/build/doc/xml/index.xml

What index.xml is meant here?