Set up a documentation pipeline
Opened this issue · 1 comments
Vectorial1024 commented
It is obvious we need an online documentation for alof-lib
.
However, existing tutorials for setting up ReadTheDocs documentation is out of date, and I for one cannot progress past the "generate rt file" step. There is also a lack of existing examples to take reference from for building a ReadTheDocs config.
Vectorial1024 commented
A very dated tutorial was found: https://mike42.me/blog/2018-06-how-to-create-effective-php-project-documentation-with-read-the-docs
Frustratingly, no real progress has been made thus far:
- doxygen does not seem to recognize modern phpdoc tags e.g.
@template
; this is a huge red flag to not use doxygen - a lot must have changed in the doxygen to sphynx pipeline because I am getting blank docs for no obvious reason
- phpDocumentor standalone phar simply hangs in my Windows PC with no explanation
- phpDocumentor Docker image is surprisingly difficult to invoke in Windows environment (why do I even need to use Docker for something this simple to begin with?)