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

Documentation prototype and ReadtheDocs CI #1921

Merged
merged 4 commits into from
May 28, 2024

Conversation

bstefanuk
Copy link
Contributor

@bstefanuk bstefanuk commented May 17, 2024

This PR adds a prototype documentation site, along with necessary CI files, for hosting Tensile docs with ROCm styling. Currently, the docs are structured with a proposed format using placeholder files.

Local build steps:

  1. Create a virtual environment: python3 -m venv .venv && source .venv/bin/activate
  2. Install the Python packages needed to build the docs: pip3 install -r docs/sphinx/requirements.txt
  3. Build the docs:
    cd docs
    python3 -m sphinx -T -b html -d _build/doctrees -D language=en . _build/html
  4. Find the built docs in _build/html/

Notes:

  • Each PR will build the documentation site as a job titled: docs/readthedocs.com:[project-id]

@bstefanuk bstefanuk added the Documentation Documentation label May 17, 2024
@bstefanuk bstefanuk requested a review from ellosel May 17, 2024 19:52
@bstefanuk bstefanuk self-assigned this May 17, 2024
@bstefanuk bstefanuk marked this pull request as ready for review May 17, 2024 19:54
@bstefanuk bstefanuk added Documentation Documentation and removed Documentation Documentation labels May 17, 2024
docs/conf.py Outdated Show resolved Hide resolved
docs/sphinx/_toc.yml.in Outdated Show resolved Hide resolved
bstefanuk and others added 2 commits May 27, 2024 16:54
docs: build out skeleton

docs: restucture toc and other minor adjustments

docs: move toc section files up a directory
ci: fix path to Doxyfile
Copy link
Contributor

@ellosel ellosel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change set establishes a base sphinx docs structure that conforms to amd docs style etc and automates generation and deployment of the docs. There are no changes to any of the Tensile code and should not impact the correctness or efficiency of the existing production code. Approve pending pipelines

LICENSE.md Outdated Show resolved Hide resolved
@bstefanuk bstefanuk merged commit 9f02c93 into ROCm:develop May 28, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants