github-starred/ollama
2
0
Fork 0
mirror of https://github.com/ollama/ollama.git synced 2026-05-06 16:11:34 -05:00
Code Issues 14.5k Packages Projects Releases 120 Wiki Activity

[PR #10732] docs: add comprehensive documentation structure and guides for Ollama #44595

New Issue
Open
opened 2026-04-25 00:10:44 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-25 00:10:44 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/ollama/ollama/pull/10732
Author: @jonas-eschle
Created: 5/16/2025
Status: 🔄 Open

Base: main ← Head: je_rtd_docs

📝 Commits (8)

  • 86cb518 docs: add comprehensive documentation structure and guides for Ollama
  • 47e6c2d docs: Add automatic documentation
  • 2f62dcd docs: enhance docs and relative placement
  • cbe44a4 docs: update
  • d54b972 ci: add doc build test
  • 1cd8aad docs: fix broken link
  • 8a0255f docs: enhance appearance
  • 7f1631b docs: enhance appearance

📊 Changes

35 files changed (+1437 additions, -1029 deletions)

View changed files

📝 .github/workflows/test.yaml (+24 -4)
➕ .readthedocs.yaml (+26 -0)
📝 README.md (+2 -2)
➕ docs/Makefile (+20 -0)
📝 docs/README.md (+31 -16)
➕ docs/_static/logo/llama.png (+0 -0)
📝 docs/api.md (+216 -82)
➕ docs/conf.py (+112 -0)
📝 docs/devs/benchmark.md (+0 -0)
📝 docs/devs/development.md (+25 -15)
➕ docs/devs/index.md (+29 -0)
➕ docs/devs/openai.md (+165 -0)
📝 docs/devs/template.md (+0 -0)
➖ docs/docker.md (+0 -78)
➖ docs/examples.md (+0 -20)
➕ docs/getting_started/examples.md (+30 -0)
📝 docs/getting_started/import.md (+29 -32)
➕ docs/getting_started/index.md (+13 -0)
📝 docs/getting_started/modelfile.md (+0 -0)
➕ docs/getting_started/quickstart.md (+73 -0)

...and 15 more files

📄 Description

As discussed in #10370, this pull request introduces an actual build for the documentation system for the project. Ideally, this can be added to Readthedocs (I would either need rights in the organization or someone else should do that, the config file is also in the PR).
There are surely improvements

The docs can be run using make html inside the docs folder. I would suggest to add a link to the main website and/or on Github (README), once the RTD build is up.

Documentation Build System

  • Added a Sphinx configuration file (docs/conf.py) and the whole setup (Makefile etc) to build the docs.

Documentation Updates

  • Reorganized the documentation structure, including renaming and moving files (e.g., docs/api.md renamed to docs/devs/api.md) and updating links in the README.md to reflect the new structure.
  • Updated the main documentation README.md to include instructions for building and contributing to the documentation.

Continuous Integration Enhancements

  • Added a new docs job to the GitHub Actions workflow (.github/workflows/test.yaml) for testing the documentation build process on Ubuntu with Python 3.10.
  • Added a .readthedocs.yaml configuration file to integrate with Read the Docs. This will need to activate the builds there.

🔄 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/ollama/ollama/pull/10732 **Author:** [@jonas-eschle](https://github.com/jonas-eschle) **Created:** 5/16/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `je_rtd_docs` --- ### 📝 Commits (8) - [`86cb518`](https://github.com/ollama/ollama/commit/86cb518fae7b0ac5788f77d8be7221bcb94861f4) docs: add comprehensive documentation structure and guides for Ollama - [`47e6c2d`](https://github.com/ollama/ollama/commit/47e6c2d7fd424466b2d14af60d9d428fcde0a1cc) docs: Add automatic documentation - [`2f62dcd`](https://github.com/ollama/ollama/commit/2f62dcda61ab3e052ef335c2280fd6813b26adae) docs: enhance docs and relative placement - [`cbe44a4`](https://github.com/ollama/ollama/commit/cbe44a475f997ac563eae2b35453f4f28e2076dc) docs: update - [`d54b972`](https://github.com/ollama/ollama/commit/d54b972b4c018f520732824cb108180d0a3400d6) ci: add doc build test - [`1cd8aad`](https://github.com/ollama/ollama/commit/1cd8aad3a501ece3e008954bff0ad62fc7ff00f5) docs: fix broken link - [`8a0255f`](https://github.com/ollama/ollama/commit/8a0255ffdfb9ce8dd967b445dbf2f88d71fff9e4) docs: enhance appearance - [`7f1631b`](https://github.com/ollama/ollama/commit/7f1631b82106054e0b50f449bcd9646aea126bd2) docs: enhance appearance ### 📊 Changes **35 files changed** (+1437 additions, -1029 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/test.yaml` (+24 -4) ➕ `.readthedocs.yaml` (+26 -0) 📝 `README.md` (+2 -2) ➕ `docs/Makefile` (+20 -0) 📝 `docs/README.md` (+31 -16) ➕ `docs/_static/logo/llama.png` (+0 -0) 📝 `docs/api.md` (+216 -82) ➕ `docs/conf.py` (+112 -0) 📝 `docs/devs/benchmark.md` (+0 -0) 📝 `docs/devs/development.md` (+25 -15) ➕ `docs/devs/index.md` (+29 -0) ➕ `docs/devs/openai.md` (+165 -0) 📝 `docs/devs/template.md` (+0 -0) ➖ `docs/docker.md` (+0 -78) ➖ `docs/examples.md` (+0 -20) ➕ `docs/getting_started/examples.md` (+30 -0) 📝 `docs/getting_started/import.md` (+29 -32) ➕ `docs/getting_started/index.md` (+13 -0) 📝 `docs/getting_started/modelfile.md` (+0 -0) ➕ `docs/getting_started/quickstart.md` (+73 -0) _...and 15 more files_ </details> ### 📄 Description As discussed in #10370, this pull request introduces an actual build for the documentation system for the project. Ideally, this can be added to Readthedocs (I would either need rights in the organization or someone else should do that, the config file is also in the PR). There are surely improvements The docs can be run using `make html` inside the docs folder. I would suggest to add a link to the main website and/or on Github (README), once the RTD build is up. ### Documentation Build System * Added a Sphinx configuration file (`docs/conf.py`) and the whole setup (Makefile etc) to build the docs. ### Documentation Updates * Reorganized the documentation structure, including renaming and moving files (e.g., `docs/api.md` renamed to `docs/devs/api.md`) and updating links in the `README.md` to reflect the new structure. * Updated the main documentation `README.md` to include instructions for building and contributing to the documentation. ### Continuous Integration Enhancements * Added a new `docs` job to the GitHub Actions workflow (`.github/workflows/test.yaml`) for testing the documentation build process on Ubuntu with Python 3.10. * Added a `.readthedocs.yaml` configuration file to integrate with Read the Docs. This will need to activate the builds there. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-25 00:10:44 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
amd
api
app
bug
build
cli
cloud
compatibility
context-length
create
docker
documentation
embeddings
feature request
feedback wanted
good first issue
gpt-oss
gpu
harmony
help wanted
image
install
intel
js
launch
linux
macos
memory
mlx
model
needs more info
networking
nvidia
ollama.com
performance
pull-request
Mirrored from GitHub Pull Request
 python
question
registry
rendering
thinking
tools
top
vulkan
windows
wsl
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/ollama#44595
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?