diff --git a/docs/source/Evennia-API.md b/docs/source/Evennia-API.md index ef2d4b790a..7088bdae53 100644 --- a/docs/source/Evennia-API.md +++ b/docs/source/Evennia-API.md @@ -2,28 +2,28 @@ - [evennia.accounts](api:evennia.accounts) - the out-of-character entity representing players - [evennia.commands](api:evennia.commands) - all inputs. Also includes default commands -- [evennia.comms](api:evennia.comms) - in-game channels and messaging +- [evennia.comms](api:evennia.comms) - in-game channels and messaging - [evennia.contrib](api:evennia.contrib) - game-specific tools and code contributed by the community -- [evennia.help](api:evennia.help) - in-game help system +- [evennia.help](api:evennia.help) - in-game help system - [evennia.locks](api:evennia.locks) - limiting access to various systems and resources - [evennia.objects](api:evennia.objects) - all in-game entities, like Rooms, Characters, Exits etc -- [evennia.prototypes](api:evennia.prototypes) - customize entities using dicts +- [evennia.prototypes](api:evennia.prototypes) - customize entities using dicts - [evennia.scripts](api:evennia.scripts) - all out-of-character game objects - [evennia.server](api:evennia.server) - core Server and Portal programs, also network protocols -- [evennia.typeclasses](api:evennia.typeclasses) - core database-python bridge -- [evennia.utils](api:evennia.utils) - lots of useful coding tools and utilities +- [evennia.typeclasses](api:evennia.typeclasses) - core database-python bridge +- [evennia.utils](api:evennia.utils) - lots of useful coding tools and utilities - [evennia.web](api:evennia.web) - webclient, website and other web resources -## Shortcuts +## Shortcuts -Evennia's 'flat API' has shortcuts to common tools, available by only importing `evennia`. +Evennia's 'flat API' has shortcuts to common tools, available by only importing `evennia`. -### Main config +### Main config -- [evennia.settings_default](github:settings_default.py) - all settings (modify/override in `mygame/server/settings.py`) +- [evennia.settings_default](github:evennia/settings_default.py) - all settings (modify/override in `mygame/server/settings.py`) ### Search functions @@ -94,5 +94,5 @@ Evennia's 'flat API' has shortcuts to common tools, available by only importing ### Contributions -- [evennia.contrib](https://github.com/evennia/evennia/blob/master/evennia/contrib/) - +- [evennia.contrib](https://github.com/evennia/evennia/blob/master/evennia/contrib/) - game-specific contributions and plugins ([docs](https://github.com/evennia/evennia/blob/master/evennia/contrib/README.md)) diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index c3e705f438..72f5fbfbc0 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -1,7 +1,9 @@ -{%- extends "classic/layout.html" %} +{%- extends "!layout.html" %} -{%- block relbaritems %} -{%- if master_doc != pagename %} - +{% if next %} +{{ next.title }} +{% endif %} + +{% if prev %} +{{ prev.title }} {% endif %} -{% endblock %} diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst deleted file mode 100644 index 346ade5719..0000000000 --- a/docs/source/api/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -evennia -======= - -.. toctree:: - :maxdepth: 4 - - evennia diff --git a/docs/source/conf.py b/docs/source/conf.py index 0929e800b4..519a0ebd36 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -76,6 +76,7 @@ html_sidebars = { } html_favicon = "_static/images/favicon.ico" html_logo = "_static/images/evennia_logo.png" +html_short_title = f"Evennia {release}" # HTML syntax highlighting style pygments_style = "sphinx" @@ -133,7 +134,7 @@ def url_resolver(url): # auto-create TOCs if a list of links is under these headers -auto_toc_sections = ["Contents", "Toc", "Index"] +auto_toc_sections = ["Contents", "Toc", "Index", "API", "Overview"] recommonmark_config = { "enable_auto_toc_tree": True, diff --git a/docs/source/layout.html b/docs/source/layout.html new file mode 100644 index 0000000000..e69de29bb2