search

rl-institut / multi-vector-simulator

Multi-vector Simulation Tool assessing and optimizing Local Energy Systems (LES) for the E-LAND project
GNU General Public License v2.0
21 stars 10 forks source link

Fix ReadTheDocs compilation and allow pdf download #849

Closed smartie2076 closed 3 years ago

smartie2076 commented 3 years ago

Currently, https://multi-vector-simulator.readthedocs.io/en/latest/ seems to lag behind the dev branch sometimes, leading to confusion. It seems that https://mvs-eland.readthedocs.io/en/latest/ is more recent, eventhough it is based on an old repo. Also, we need to make the RTD downloadable as a PDF for the deliverable 4.4.

Bachibouzouk commented 3 years ago

to check the integrity of links : sphinx-build . -b linkcheck -d _build/doctrees _build/html

Bachibouzouk commented 3 years ago

It is wierd, I created a new version of RTD on a branch and the build triggered the creation of the PDF and Epub, but now it is not there anymore...

smartie2076 commented 3 years ago

I feel like the old and new repo (mvs-eland and multi-vector-simulator) are unhealthily connected, and we should delete both to cut those connections. Maybe everything is synchronised and working then?

Bachibouzouk commented 3 years ago

I removed mvs-eland from RTD

smartie2076 commented 3 years ago

Okay, nice. Didn´t work when I did it last time, but https://mvs-eland.readthedocs.io/ is inactive now :)

smartie2076 commented 3 years ago

Ah, I did not see that open checklist item in the first post and commented the lag in #853. It is a weird occurrance :/

But I saw that on the fix/RTD-build the pdf compilation works: https://multi-vector-simulator.readthedocs.io/_/downloads/en/fix-rtd-build/pdf/ The table of contents is a bit weird and does not show our chapters/sections, but it looks very promising :D This will be great!

Bachibouzouk commented 3 years ago

I will merge the branch fix/RTD-build once again in dev

Now I saw that the layout of the pdf was not so nice but I found a solution!!! :D

Use readthedoc's readthedocs structure :P

https://raw.githubusercontent.com/readthedocs/readthedocs.org/db24ee1fff270717ec359a74f9a330fa78912829/docs/index.rst

https://docs.readthedocs.io/en/stable/

https://docs.readthedocs.io/_/downloads/en/stable/pdf/