rpng / open_vins

An open source platform for visual-inertial navigation research.
https://docs.openvins.com
GNU General Public License v3.0
2.13k stars 630 forks source link

support building of pdf reference manual #214

Closed A1R0B0T closed 2 years ago

A1R0B0T commented 2 years ago

There are some errors when I build pdf reference manual:

Screenshot from 2021-12-23 15-57-30 Screenshot from 2021-12-23 16-02-54

My system:

Ubuntu 18.04 Doxygen: 1.8.13 pdfTeX 3.14159265-2.6-1.40.18 (TeX Live 2017/Debian) So I change the Doxyfile and bib file to fix these errors:

add EXTRA_PACKAGES in Doxyfile escape '%' in bib file

goldbattle commented 2 years ago

Thanks for the PR. Can you give some instructions on how I can build this? Right now I have only used m.css to build the documentation website: https://docs.openvins.com/dev-docs.html#developers-building

Is this PDF form actually useful and something we should provide?

A1R0B0T commented 2 years ago

Thanks for the PR. Can you give some instructions on how I can build this? Right now I have only used m.css to build the documentation website: https://docs.openvins.com/dev-docs.html#developers-building

Is this PDF form actually useful and something we should provide?

Hi,

First, please install doxygen and texlive, for example (ubuntu): $ sudo apt install doxygen texlive-full

Then, generate and build using: $ doxygen && cd doxgen_generated/latex && make

I will add these instructions in "8.2 Documentation Guide".

I think this PDF is very useful, and I'd like to use this PDF on my secondary screen for reference.

goldbattle commented 2 years ago

Here is an example build for those interested. refman.pdf