Using sphinx to generate html pages for our project static site #153
Conversation
|
we do not want that deep hierarchy, can we move all files under docs directly? i will help refactor rest folders later. |
docs/website/docs/README.md
Outdated
| Make sure that your python conda environment is setup correctly. The following installs sphinx package and necessary templates. | ||
|
|
||
| ```bash | ||
| python -m pip install sphinx |
There was a problem hiding this comment.
installation should be consistent? why not directly use pip?
docs/website/docs/README.md
Outdated
|
|
||
| ```bash | ||
| python -m pip install sphinx | ||
| pip install sphinx-book-theme |
There was a problem hiding this comment.
if we have more dependencies, let's create a requirement.txt to track the dependencies. It would be great to pin the version.
docs/website/docs/source/conf.py
Outdated
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information | ||
|
|
||
| project = 'AIBrix' | ||
| copyright = '2024, ByteDance InfraLab-Compute' |
docs/website/docs/source/conf.py
Outdated
|
|
||
| project = 'AIBrix' | ||
| copyright = '2024, ByteDance InfraLab-Compute' | ||
| author = 'ByteDance InfraLab-Compute' |
I think it is confusing If the source folder is mixed with "tutorial" folder and others. Yes, I can move it if there is refactor for the existed folders. |
|
@xinchen384 Yeah, mixing tutorial etc and source together is an intermediate state. we will refactor it in coming days. |
|
I have pinned the pip version. Since this is just for webpage, the 2 dependencies are all we need. Everything else is updated accordingly. @Jeffwan |
|
The change looks good to me! Great to see we have a site now! |
|
Feel free to merge it once the CI pass |
* using sphinx build html pages * update readme * reorg doc path * update command with new parent dir * update author --------- Co-authored-by: xin.chen <[email protected]>
Pull Request Description
Set up basic layout of AIbrix's static site with html pages.
Related Issues
Resolves: #[Insert issue number(s)]
Here is a screen shot.
Important: Before submitting, please complete the description above and review the checklist below.
Contribution Guidelines (Expand for Details)
We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:
Pull Request Title Format
Your PR title should start with one of these prefixes to indicate the nature of the change:
[Bug]: Corrections to existing functionality[CI]: Changes to build process or CI pipeline[Docs]: Updates or additions to documentation[API]: Modifications to aibrix's API or interface[CLI]: Changes or additions to the Command Line Interface[Misc]: For changes not covered above (use sparingly)Note: For changes spanning multiple categories, use multiple prefixes in order of importance.
Submission Checklist
By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.