Update Instructions for Building RST Documentation
@robfrawley is already working on this.
Since Nov 20, 2021.
- Dominant language
- PHP
- Stars
- 1.7k
- Forks
- 386
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 3
Description
Problem Details
The symfony/symfony-docs project has changed their RST documentation build procedure from a Python and Sphinx compilation process to a PHP application in symfony/symfony-docs#16068.
The new RST documentation build process relies on an internal (and not officially supported, but MIT licensed) PHP command-line app in the symfony-tools/docs-builder project, which internally utilizes the doctrine/rst-parser library for RST parsing.
Over the next week or two, I will be updating the Wiki instructions for this bundle to use the new symfony/symfony-docs RST documentation build procedure, and will further provide a pull request to address any changes needed within the project itself to facilitate the new RST compilation procedure.
If anyone has any feedback as to how our RST build instructions could otherwise be improved, or if anyone has any input as the primary goals of this report, please feel free to comment. Otherwise, I will provide updates here as I progress.
Template Questions
Preconditions / Steps to Reproduce
- Follow the RST documentation compilation instructions from github.com/liip/LiipImagineBundle/wiki/Building-RST-Documentation.
Expected Result
- The bundle RST documentation is compiled into HTML.
Actual Result
- An large number of steps fail due to the instruction's reliance on
symfony/symfony-docsfiles and build process.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.