This is an archive of the discontinued LLVM Phabricator instance.

[doc] added section on generating the html doc
ClosedPublic

Authored by kuhnel on Aug 4 2021, 7:27 AM.

Details

Summary

Added a new section on generating the html documentation from the rst/md sources to our documentation.

Background: I wanted to check what my documentation changes would look like on the website and had a hard time finding how to do that. So I wanted to save other folks the effort.

This is based on the discussion in https://github.com/llvm/llvm-iwg/issues/17

Diff Detail

Event Timeline

kuhnel requested review of this revision.Aug 4 2021, 7:27 AM
kuhnel created this revision.
Herald added a project: Restricted Project. · View Herald TranscriptAug 4 2021, 7:27 AM
kuhnel updated this revision to Diff 364099.Aug 4 2021, 7:27 AM

fixed missing empty line

kuhnel edited the summary of this revision. (Show Details)Aug 4 2021, 7:29 AM
kuhnel added a reviewer: tstellar.

Do you want to mention this script: https://reviews.llvm.org/D95284

Do you want to mention this script: https://reviews.llvm.org/D95284

I thought about it, but the patch has not yet landed and I did not want to point to an ongoing review.

So If you land your patch we can add something like:

To create the documentation for a release you can use the script in 
`llvm/utils/release/build-docs.sh <https://github.com/llvm/llvm-project/commits/main/llvm/utils/release/build-docs.sh]>`_.

So, let me land this change and once your shell script is ready, we'll add another sentence to the documentation.

This revision was not accepted when it landed; it landed in state Needs Review.Aug 9 2021, 12:28 AM
This revision was landed with ongoing or failed builds.
This revision was automatically updated to reflect the committed changes.