Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documentation setup

Browse source
This commit is contained in:
Griatch 2020-06-12 20:33:11 +02:00
parent d072950cc5
commit 607db6206a
4 changed files with 34 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/source/conf.py
View file

@ -163,9 +163,11 @@ def url_resolver(url):
elif url.startswith(urlstart):
return _github_code_root + url[len(urlstart):]
elif url.startswith(apistart):
print("api: -> api ref")
return "api/" + url[len(apistart):] + ".html"
else:
return _github_doc_root + url
return url
# else:
# return _github_doc_root + url
# auto-create TOCs if a list of links is under these headers

3
docs/source/index.md
View file

@ -11,7 +11,8 @@ suggestion box][form]!
There is [a lengthier introduction](Evennia-Introduction) to read. You might also want to read about
[how to get and give help](How-To-Get-And-Give-Help).
| [![Getting Started][icon_new]](Getting-Started)| [![Admin Docs][icon_admin]](Administrative-Docs) | [![Builder Docs][icon_builder]](Builder-Docs) | [![Developer-Central][icon_devel]](Developer-Central) | [![tutorial][icon_tutorial]](Tutorials) | [![API][icon_API]](api:evennia) |
| ![Getting Started][icon_new]| ![Admin Docs][icon_admin] | ![Builder Docs][icon_builder] | ![Developer-Central][icon_devel] | ![Tutorials][icon_tutorial] | [![API][icon_API]](api:evennia) |
|-----------------|----------------------|--------------------------|----------------------|----------------------------|--------------------|
|[Getting Started](Getting-Started)| [Admin Docs](Administrative-Docs) | [Builder Docs](Builder-Docs) | [Developer Central](Developer-Central) | [Tutorials & Examples](Tutorials) | [API](api:evennia) |

2
docs/source/toc.md
View file

@ -69,7 +69,7 @@
* [HAProxy Config (Optional)](HAProxy-Config-(Optional).md)
* [Help System Tutorial](Help-System-Tutorial.md)
* [Help System](Help-System.md)
* [Home](Home.md)
* [Home](index.md)
* [How To Get And Give Help](How-To-Get-And-Give-Help.md)
* [How to connect Evennia to Twitter](How-to-connect-Evennia-to-Twitter.md)
* [IRC](IRC.md)