search

dkriegner / xrayutilities

xrayutilities - a package with useful scripts for X-ray diffraction physicists
http://xrayutilities.sourceforge.io
GNU General Public License v2.0
81 stars 29 forks source link

release management: create manually triggered documentation build (azure) #114

Closed dkriegner closed 3 years ago

dkriegner commented 3 years ago

The documentation (especially the webpage) could be automatically created by an azure pipeline. If one saves there the secrets for the sourceforge upload it could also be automatically uploaded which would make the generation of new releases or generally the casual update of the webpage much more straight forward.

The question is how one should proceed with the pdf documentation?

I personally never open it except to check the formatting did not break. I would keep it around for the time being but its maybe not needed in the package sources. Anybody has opinions on this?

dkriegner commented 3 years ago

files which can be generated from the sources will be removed from the GIT repository. This includes some of the *.rst files in doc/source and the xrayutilities.pdf file. I will continue to ship the pdf with the tarballs for the moment.

dkriegner commented 3 years ago

I changed my opinion about shipping the PDF file. Since everybody who needs it can generate it locally this seems not very important. Instead the up to date PDF documentation will be available for download on the documentation webpage.