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

Document generation of the website #17

Closed
ChristianKuehnel opened this issue Apr 9, 2021 · 4 comments
Closed

Document generation of the website #17

ChristianKuehnel opened this issue Apr 9, 2021 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ChristianKuehnel
Copy link
Collaborator

I did not find any documentation on how to generate the html code of the website from the monorepo. This would be useful to have to test changes locally.

Once we have that, add this to the documentation tutorials so people find it:

@ChristianKuehnel ChristianKuehnel added the documentation Improvements or additions to documentation label Apr 9, 2021
@ChristianKuehnel ChristianKuehnel changed the title Document gerneration of the website Document generation of the website Apr 9, 2021
@ChristianKuehnel
Copy link
Collaborator Author

some discussion on the mailing list recently, check that for details

@ChristianKuehnel
Copy link
Collaborator Author

Dug up the commands as I just tested my own documentation change, maybe that helps:

# tools needed in addition to cmake, ninja, build-essentials, ...
sudo apt install -y sphinx-doc python-recommonmark-doc
mkdir build
cd build
cmake -G Ninja -DLLVM_ENABLE_SPHINX=On ../llvm
ninja docs-llvm-html

@tstellar
Copy link
Collaborator

I wrote a script here: https://reviews.llvm.org/D95284

@ChristianKuehnel
Copy link
Collaborator Author

I added a pure documentation patch for manually creating the documentation locally:
https://reviews.llvm.org/D107460

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

3 participants