create mkdocs documentation#27
create mkdocs documentation#27antoniorodr wants to merge 1 commit intoAran404:mainfrom antoniorodr:mkdocs
Conversation
|
Honestly I have no clue how any of this works |
Do you mean the docs? It's not that hard. I didn't knew it either, but I did read the documentation. What do you think about the idea? |
|
Like all that commit stuff you did |
|
Oh, I did a contribution through a pull request. I did not change anything about the "main code". Only the necessary to have the documentation ready to be hosted and the pyproject file, which is the "new version" of the requirements.txt. |
|
Yeah I understand that but I don't have the expertise to know if it's a correct commit 😄 |
|
I am not that experienced, but you can see the changes yourself and choose |
|
How does Pyproject work? Do I need to update pypi or something? |
No you don’t. I create it with uv when I create my venv. You can read a little bit more here |
|
We can go through with this but you'd have to hold my hand a little |
|
Sure, what do you need? I did not delete the requirements.txt tho. |
|
Those docs look nice, how's that work? All this is foreign to me |
|
Right now I just wrote a bit of the necessary "code" to make the docs as you see in the picture. If you think it's looks nice and want to use is (they have a lot of documentation, and I can try to explain a bit if you want) so can I help you to build it. It's just a command we need to use tho. |
|
Alright |
|
Okay. I can do it in my fork and then update the PR, if you want? |
|
Will do later |
Great! |
|
Sorry been really sick so haven't been on my pc, will get to when I'm feeling better |
No hurry mate |
|
@Aran404 Is this PR still valid / something you're planning to move forward with? |
|
Yes sir, what do I need to do? |
|
Close the PR due to lack of response. |
2 participants
Ive created basic documentation in MkDocs. The website is not created yet, but you can see the result if you run
mkdocs serveand open the live server.If you like it, I can then build the website.
Ive created a pyproject.toml too, which is the new standard for dependences.
Preview: