Cleanup the manual and merge into the main repository

votca / ctp

charge transport module

https://gitlab.mpcdf.mpg.de/votca/votca

7 stars 11 forks source link

Cleanup the manual and merge into the main repository #95

Closed crionez closed 6 years ago

crionez commented 6 years ago

installation should compile the manual and install it into manuals folder of VOTCA

junghans commented 6 years ago

ctp-manual hasn't been converted to CMake yet, but the manual in xtp should have all the pieces.

junghans commented 6 years ago

I think the manual should not be build by default due to all the latex dependencies, so something like:

 option(BUILD_CTP_MANUAL "Build ctp-manual" OFF)
if(BUILD_CTP_MANUAL)
  add_subdirectory(manual)
endif()

would be good.

crionez commented 6 years ago

@junghans: you can delete the ctp-manual repository

junghans commented 6 years ago

Looking at https://travis-ci.org/votca/ctp/builds/367408139 there are a bunch of issues:

On fedora:

CMake Error at ctp/manual/CMakeModules/UseLATEX.cmake:1068 (message):
Could not find convert program.  Please download ImageMagick from
http://www.imagemagick.org and install.

On Ubuntu, which has convert:

CMake Warning (dev) at ctp/manual/CMakeLists.txt:53 (add_custom_target):
Policy CMP0002 is not set: Logical target names must be globally unique.
Run "cmake --help-policy CMP0002" for policy details.  Use the cmake_policy
command to set the policy and suppress this warning.
This warning is for project developers.  Use -Wno-dev to suppress it.

This means there is a conflict with other manual targets.

In general:

CMake Error at ctp/manual/CMakeModules/UseLATEX.cmake:1652 (add_custom_target):
Cannot find source file:
reference/xml/map.xml.tex
Tried extensions .c .C .c++ .cc .cpp .cxx .m .M .mm .h .hh .h++ .hm .hpp
.hxx .in .txx

junghans commented 6 years ago

I fixed the first two in 0b8002eade84f9ede45cac9b349e5ea31ec903a6 and votca/buildenv#15

junghans commented 6 years ago

Also if you want the ctp-manual to get automatically deployed to http://doc.votca.org (like for csg), we will need to modify votca/votca as well.

crionez commented 6 years ago

Ok. Had a look at it. No clue what to modify ;) Any hints?

junghans commented 6 years ago

I will make a PR later today.

junghans commented 6 years ago

See votca/votca#60

junghans commented 6 years ago

In https://travis-ci.org/votca/ctp/jobs/368294348 we get:

[  1%] Generating calculator_refs
cd /home/votca/votca/build/ctp/manual && ../../../ctp/manual/scripts/extract_calculators.sh /home/votca/votca/build/ctp/manual/reference/calculators.tex
[91m../../../ctp/manual/scripts/extract_calculators.sh: line 3: csg_call: command not found
[0m[91mmake[2]: *** [ctp/manual/CMakeFiles/ctp-manual_pdf.dir/build.make:133: ctp/manual/calculator_refs] Error 127
[0mmake[2]: Leaving directory '/home/votca/votca/build'

I guess the manual needs to depend csg_call being build first and then used from build directory.

Have a look at what I did in the xtp manual.

junghans commented 6 years ago

I half-assed something together in #97.

junghans commented 6 years ago

Deploy works: http://doc.votca.org/ctp-manual.pdf

This pdf will get updated every time, you update the ctp submodule in votca/votca.