Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up a documentation pipeline #1

Open
Vectorial1024 opened this issue Nov 25, 2023 · 1 comment
Open

Set up a documentation pipeline #1

Vectorial1024 opened this issue Nov 25, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Vectorial1024
Copy link
Owner

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 Vectorial1024 added the documentation Improvements or additions to documentation label Nov 25, 2023
@Vectorial1024 Vectorial1024 pinned this issue Nov 25, 2023
@Vectorial1024
Copy link
Owner Author

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?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant