search

tudo-astroparticlephysics / PROPOSAL

Monte Carlo Simulation propagating charged Leptons through Media as C++ Library
GNU Lesser General Public License v3.0
35 stars 21 forks source link

Documentation #32

Open asandrock opened 5 years ago

asandrock commented 5 years ago

The main page of the HTML documentation contains no links whatsoever to the other pages.

Jean1995 commented 4 years ago

We need to rework the whole documentation at some point.

At the moment, we have parts of a Doxygen documentation (C++) and recently we started to work on a Sphinx documentation (python, via pybind11). It would be lovely to have a combined documentation, maybe a tool such as breathe could be helpful?

maxnoe commented 4 years ago

This could also be pushed to the github pages

afedynitch commented 4 years ago

Hi!

I started using PROPOSAL for some custom application, which requires modifications to the source code. So why not having a look at the documentation? Well, it builds infinitely long (make doc) and contains apparently the entire gtest, gmock, pybind11 docs. In particular, these are all default docs without useful content.

1) Please remove default documentation, in particular that of third party codes. People who can decipher what it tries to say put in HTML can easily read the source code and use IntelliSense to browse around.

2) The only useful thing that comes out of doxygen by default IMO are the class hierarchies. The rest needs customization and text written by people. There is no practical use of autodoc without docstrings.