search

flatsurf / e-antic

Embedded algebraic number fields
https://flatsurf.github.io/e-antic/libeantic/
GNU Lesser General Public License v3.0
12 stars 11 forks source link

Distribute doc/ in tarball #231

Closed saraedum closed 1 year ago

saraedum commented 2 years ago

Currently, doc/ is missing from the tarball because we are building the tarball --without-doc.

It should be included and maybe it should be in a shape that it could be installed locally. (Actually, building it is probably not very realistic since it requires an unreleased version of standardese.)

jgmbenoit commented 2 years ago

Is it a good idea to use not wide spread softwares to build package ?

saraedum commented 2 years ago

I am not sure what you are proposing exactly. Doxygen had a lot of limitations that we did not want to accept when writing the documentation here.

We intend for the documentation to be hosted on our website so using software that is not available in most distributions immediately was not much of a concern. In my experience, very few people use the installed documentation unless it's a man page but I might be mistaken. We aim to have very readable documentation in the header files which is somewhat hard to achieve with doxygen imho.

Anyway, the situation is of course not ideal. But maybe some projects have to begin to explore non-standard tools so these tools might become standard tools some day.

jgmbenoit commented 2 years ago

Can you at least put the output documents in the source tarball so that users without stable or permanent internet connection can have the manual on their box.

saraedum commented 2 years ago

We'll discuss whether we want to include this in the source tarball or distribute it separately in a call tomorrow. The (unversioned) built documentation can already be downloaded from https://github.com/flatsurf/e-antic/archive/refs/heads/gh-pages.zip at the moment.

saraedum commented 2 years ago

We'll make sure to distribute the built documentation as a separate tarball with every release.