[PR #27] [CLOSED] create mkdocs documentation #45

New issue

Closed

opened 2026-02-27 19:06:37 +03:00 by kerem · 0 comments

kerem commented

2026-02-27 19:06:37 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Aran404/SpotAPI/pull/27
Author: @antoniorodr
Created: 3/20/2025
Status: ❌ Closed

Base: main ← Head: mkdocs

📝 Commits (1)

623df6f create mkdocs documentation

📊 Changes

6 files changed (+160 additions, -0 deletions)

View changed files

📝 .gitignore (+1 -0)
➕ docs/.nav.yml (+16 -0)
➕ docs/index.md (+15 -0)
➕ docs/installation.md (+73 -0)
➕ mkdocs.yml (+37 -0)
➕ pyproject.toml (+18 -0)

📄 Description

Ive created basic documentation in MkDocs. The website is not created yet, but you can see the result if you run mkdocs serve and 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:

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Aran404/SpotAPI/pull/27 **Author:** [@antoniorodr](https://github.com/antoniorodr) **Created:** 3/20/2025 **Status:** ❌ Closed **Base:** `main` ← **Head:** `mkdocs` --- ### 📝 Commits (1) - [`623df6f`](https://github.com/Aran404/SpotAPI/commit/623df6f00af22ece74984f6f351c24a24cffc891) create mkdocs documentation ### 📊 Changes **6 files changed** (+160 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `.gitignore` (+1 -0) ➕ `docs/.nav.yml` (+16 -0) ➕ `docs/index.md` (+15 -0) ➕ `docs/installation.md` (+73 -0) ➕ `mkdocs.yml` (+37 -0) ➕ `pyproject.toml` (+18 -0) </details> ### 📄 Description Ive created basic documentation in MkDocs. The website is not created yet, but you can see the result if you run `mkdocs serve` and 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: <img width="1721" alt="image" src="https://github.com/user-attachments/assets/bee6597c-4e4b-48ad-a824-0f46c79d81b2" /> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>