AlexCouch / miavortaro-py

La Python-a libraro por komunuki kaj sendi API-ajn mesaĝojn al miavortaro
Apache License 2.0
0 stars 0 forks source link

Fiksu la Github Action por Sphinx #1

Closed AlexCouch closed 2 years ago

AlexCouch commented 2 years ago

Resumo

Ni devas fiski la Github Action por Sphinx (.github/workflows/sphinx.yml) por ke ni povas generi la dokumentaĵojn de la libraro.

Kio Okazis?

La Sphinx aŭtomata genero daŭras malkonstrui la dokumentaĵojn, pro tio, jene:

  1. Kiam ni kurigas ĝin sen ŝanĝoj, /tmp/sphinx-log malekzistas kaj ĝi malsukcesas
  2. Kiam ni kreas /tmp/sphinx-log, ĝi ne tute konstruas pro ia malkonata kialo (nur "Build Failed" eraro)
  3. Mi provis enmeti la enigaĵojn por la "sphinx-build" komando memstare anstataŭ la kutimaj komandoj, kaj malsukcesis ("Build Failed")

Kio Alia?

Ni devas solvi tial kial ĉi tiu ne plu funkcias. Mi sekvis la dokumentaron jene: https://www.sphinx-doc.org/en/master/tutorial/deploying.html#id1, kaj ĝi plu malfunkcias, ne gravas tio, kion mi penas.

English Summary

We have to fix the Github Action for Sphinx (.github/workflows/sphinx.yml) so that we can generate the documentation for the library.

What happened?

The Sphinx automated generation continues to not build the documentation because of the following:

  1. When we run it without changes, /tmp/sphinx-log doesn't exist and it fails
  2. When we create /tmp/sphinx-log, it doesn't work at all because of some kind of unknown error (only "Build Failed" error)
  3. I tried to input the arguments for the "sphinx-build" command by itself instead of the usual command, and failed ("Build Failed")

What Else?

We have to figure out why this no longer works. I followed the documentation here: https://www.sphinx-doc.org/en/master/tutorial/deploying.html#id1, and it still doesn't work, no matter what I try.

AlexCouch commented 2 years ago

Mi solvis tiun ĉi pere de la movado de la Sphinx dosieroj. Ili ne estis en la ĝusta strukturo. La Makefile ktp devis esti en docs/.