-
-
Notifications
You must be signed in to change notification settings - Fork 62
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
docs: π Introduce mkdocs-material into python-multipart project as new documentation #108
Conversation
Signed-off-by: Onuralp SEZER <[email protected]>
Signed-off-by: Onuralp SEZER <[email protected]>
Signed-off-by: Onuralp SEZER <[email protected]>
Hello @Kludex I am trying to replicate old document as it is as possible reference for "page structure" and as preview I had to change document section so it can render properly Light theme Dark theme If you have an different idea or suggestion also please let me know. Until then I will follow based on current documentation structure as possible as I can after initial work done, we can merge or change in here and then merge but I want to give you update how is it look in early. |
Signed-off-by: Onuralp SEZER <[email protected]>
Signed-off-by: Onuralp SEZER <[email protected]>
β¦rt-classes added Signed-off-by: Onuralp SEZER <[email protected]>
How to Testgit clone [email protected]:onuralpszr/python-multipart.git -b doc/mkdocs-material python-multipart-docs
cd python-multipart-docs
python3.10 -m venv .venv
source .venv/bin/activate
pip install mkdocs==1.5.3 mkdocs-material==9.5.9 mkdocs-git-authors-plugin==0.7.2 mkdocs-git-revision-date-localized-plugin==1.2.4 mkdocs-material-extensions==1.3.1 pymdown-extensions==10.7 mkdocstrings==0.24.0 mkdocstrings-python==1.8.0 mkdocs-autorefs==0.5.0 mkdocs-git-committers-plugin-2==2.2.3
mkdocs serve |
Signed-off-by: Onuralp SEZER <[email protected]>
Signed-off-by: Onuralp SEZER <[email protected]>
@Kludex it is ready for review and how to test also added for quickly copy/paste and see it. It should be mostly ready for first round I believe so please check it when you had time Thank you. :) |
Signed-off-by: Onuralp SEZER <[email protected]>
I was fixing a lot of stuff, and now you pushed more stuff :/ |
I did not know, I am stopping for now. |
I'm force pushing my changes, FYI. (the 3 last commits will be lost) |
8372098
to
f37d15e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! π
Further improvements are welcome, but I prefer to go with the simplest, so I've removed a bit of complexity.
Okay thank you. I understand, since this was first it is okay. |
As part of change process I am will be update every step for easy reviews and move parts to mkdocs-material and create config plus github action and It will replace new old documentation
How to Test
Fix : #101