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

docs: πŸ“ Introduce mkdocs-material into python-multipart project as new documentation #108

Merged
merged 10 commits into from
Feb 11, 2024

Conversation

onuralpszr
Copy link
Contributor

@onuralpszr onuralpszr commented Feb 11, 2024

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

  • docs: ✨ decoders,exceptions,helper-functions,main-class,parsers,support-classes added
  • docs: ✨ set sphinx doc style as default
  • docs: ✨ initial mkdocs pages and documentation added, old docs removed
  • docs: ✨ mkdocs-material packages added as doc-dep
  • docs: 🧹 removal of old documents,packages,requirements
  • chore: 🧹 python.gitignore added
  • fix: 🐞 package typo fix
  • docs: ✨ home page, quickstart sections added

How to Test

git clone git@github.com: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

Fix : #101

Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
Copy link
Contributor Author

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

image

Dark theme

image

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 <thunderbirdtr@gmail.com>
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
…rt-classes added

Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr
Copy link
Contributor Author

How to Test

git clone git@github.com: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 <thunderbirdtr@gmail.com>
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@onuralpszr onuralpszr marked this pull request as ready for review February 11, 2024 17:38
@onuralpszr
Copy link
Contributor Author

@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. :)

onuralpszr and others added 2 commits February 11, 2024 20:49
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
@Kludex
Copy link
Owner

Kludex commented Feb 11, 2024

I was fixing a lot of stuff, and now you pushed more stuff :/

@onuralpszr
Copy link
Contributor Author

I was fixing a lot of stuff, and now you pushed more stuff :/

I did not know, I am stopping for now.

@Kludex
Copy link
Owner

Kludex commented Feb 11, 2024

I'm force pushing my changes, FYI. (the 3 last commits will be lost)

Copy link
Owner

@Kludex Kludex left a 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.

@Kludex Kludex merged commit 1474796 into Kludex:master Feb 11, 2024
6 checks passed
@onuralpszr
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move docs to MkDocs
2 participants