diff --git a/docs/pylib/copy_from_wiki.py b/docs/pylib/copy_from_wiki.py index 34d9b94b0b..151eb37b3f 100644 --- a/docs/pylib/copy_from_wiki.py +++ b/docs/pylib/copy_from_wiki.py @@ -18,13 +18,13 @@ import re import datetime _RE_MD_LINK = re.compile(r"\[(?P[\w -\[\]]+?)\]\((?P.+?)\)", re.I + re.S + re.U) -_RE_REF_LINK = re.compile(r"\[[\w -\[\]]+?\]\(.+?\)", re.I + re.S + re.U) +_RE_REF_LINK = re.compile(r"\[[\w -\[\]]*?\]\(.+?\)", re.I + re.S + re.U) _RE_CLEAN = re.compile(r"\|-+?|-+\|", re.I + re.S + re.U) _IGNORE_FILES = ( "_Sidebar.md", - "Wiki-Index.md" + # "Wiki-Index.md" ) _INDEX_PREFIX = f""" @@ -82,6 +82,7 @@ _REF_REMAP = { "[![Developer-Central][icon_devel]](Developer-Central)": "![Developer-Central][icon_devel]", "[![tutorial][icon_tutorial]](Tutorials)": "![Tutorials][icon_tutorial]", "[![API][icon_api]](evennia)": "![API][icon_api]", + "[](Wiki-front-page.)": "", } @@ -148,17 +149,18 @@ def _sub_link(match): if url.startswith(_OLD_WIKI_URL): # old wiki is an url on the form https:///wiki/TextTags#header # we don't refer to the old wiki but use internal mapping. - url_conv = url[_OLD_WIKI_URL_LEN:] - url_conv = re.sub(r"%20", "-", url_conv) - if url_conv.endswith("/_edit"): - # this is actually a bug in the wiki format - url_conv = url_conv[:-6] - if url_conv.startswith("evennia"): - # this is an api link - url_conv = _CODE_PREFIX + url_conv + if len(url) != len(_OLD_WIKI_URL): + url_conv = url[_OLD_WIKI_URL_LEN:] + url_conv = re.sub(r"%20", "-", url_conv) + if url_conv.endswith("/_edit"): + # this is actually a bug in the wiki format + url_conv = url_conv[:-6] + if url_conv.startswith("evennia"): + # this is an api link + url_conv = _CODE_PREFIX + url_conv - print(f" Converting wiki-url: {url} -> {url_conv}") - url = url_conv + print(f" Converting wiki-url: {url} -> {url_conv}") + url = url_conv if not url and anchor: # this happens on same-file #labels in wiki @@ -234,6 +236,11 @@ def convert_links(files, outdir): if is_index: text = _INDEX_PREFIX + text + lines = text.split("\n") + lines = (lines[:-11] + + [" - The [TOC](toc) lists all regular documentation pages.\n\n"] + + lines[-11:]) + text = "\n".join(lines) _CURRENT_TITLE = title.replace(" ", "-") text = _RE_CLEAN.sub("", text) diff --git a/docs/source/Wiki-Index.md b/docs/source/Wiki-Index.md new file mode 100644 index 0000000000..f05edba311 --- /dev/null +++ b/docs/source/Wiki-Index.md @@ -0,0 +1,151 @@ +# Wiki Index + + + +*This wiki index is automatically generated. Do not modify, your changes will be lost.* + +## A-Z + +There are 141 entries in the wiki. + +- [A voice operated elevator using events](A-voice-operated-elevator-using-events) - Adding-an-elevator-using-the-in-game-Python-system +- [Accounts](Accounts) - This-stores-passwords-and-acts-as-the-'account'-that-controls-in-game-characters. +- [Add a simple new web page](Add-a-simple-new-web-page) - Simple-tutorial-for-getting-going-with-the-web-components-of-evennia +- [Add a wiki on your website](Add-a-wiki-on-your-website) - Add-a-wiki-on-your-website-through-Django-wiki +- [Adding command tutorial](Adding-Command-Tutorial) - First-steps-for-changing-commands. +- [Adding object typeclass tutorial](Adding-Object-Typeclass-Tutorial) - Describes-adding-a-simple-typeclass. +- [Administrative docs](Administrative-Docs) - Administration-section-index. +- [Apache config](Apache-Config) - Optional-info-for-using-Apache-as-a-webserver-instead-of-Evennia's-own. +- [Api refactoring](API-refactoring) - A page about Api refactoring. +- [Arxcode installing help](Arxcode-installing-help) - A page about Arxcode installing help. +- [Async process](Async-Process) - Using-asynchronous-techniques-to-avoid-blocking-the-server-(advanced). +- [Attributes](Attributes) - Used-for-storing-arbitrary-data,-using-for-example-obj.db.name=value. +- [Banning](Banning) - How-to-get-rid-of-unwanted-players. +- [Batch code processor](Batch-Code-Processor) - Running-code-snippets-for-building-by-reading-from-a-text-file. +- [Batch command processor](Batch-Command-Processor) - Running-building-game-commands-from-a-text-file. +- [Batch processors](Batch-Processors) - Overview-of-the-mechanism-for-reading-build-instructions-from-text-files. +- [Bootstrap & evennia](Bootstrap-&-Evennia) - A page about Bootstrap & evennia. +- [Bootstrap components and utilities](Bootstrap-Components-and-Utilities) - A page about Bootstrap components and utilities. +- [Builder docs](Builder-Docs) - Index-for-all-pages-related-to-building-a-game-world. +- [Building a mech tutorial](Building-a-mech-tutorial) - A page about Building a mech tutorial. +- [Building menus](Building-menus) - Describe-building-menus-in-a-tutorial. +- [Building permissions](Building-Permissions) - Changing-account's-access-and-describes-the-permission-hierarchy. +- [Building quickstart](Building-Quickstart) - Introduces-some-basic-commands-and-builds-some-example-objects. +- [Choosing an sql server](Choosing-An-SQL-Server) - Information-about-the-various-database-systems-which-are-supported. +- [Client support grid](Client-Support-Grid) - A page about Client support grid. +- [Coding faq](Coding-FAQ) - A page about Coding faq. +- [Coding introduction](Coding-Introduction) - Some-brief-points-to-think-about-when-starting-to-use-the-system. +- [Coding utils](Coding-Utils) - A-non-complete-list-of-some-of-the-useful-code-utilities-in-src/utils. +- [Command cooldown](Command-Cooldown) - A-tutorial-for-making-commands-that-cannot-be-repeated-until-after-a-cooldown-time-has-passed. +- [Command duration](Command-Duration) - A-tutorial-for-creating-commands-that-take-time-to-complete-(advanced). +- [Command prompt](Command-Prompt) - A-little-hint-for-how-to-add-a-command-prompt-for-players-to-see. +- [Command sets](Command-Sets) - Containers-for-commands,-merges-to-describe-which-commands-are-available-at-any-moment. +- [Command system](Command-System) - A page about Command system. +- [Commands](Commands) - Main-technical-description-of-commands-and-how-they-work. +- [Communications](Communications) - How-to-code-with-Channels,-Messages-and-other-systems-for-sending-info-to-others. +- [Connection screen](Connection-Screen) - Describes-how-to-change-the-connection-screen-you-see-when-first-connecting. +- [Continuous integration](Continuous-Integration) - A page about Continuous integration. +- [Contributing](Contributing) - How-to-help-out-in-the-development-of-Evennia. +- [Coordinates](Coordinates) - A page about Coordinates. +- [Custom protocols](Custom-Protocols) - Implementing-new-server-protocols-(advanced). +- [Customize channels](Customize-channels) - A-tutorial-on-customizing-channel-commands. +- [Debugging](Debugging) - Debugging-code-with-pdb +- [Default command help](Default-Command-Help) - A page about Default command help. +- [Default exit errors](Default-Exit-Errors) - A-tutorial-for-changing-what-error-you-get-when-walking-in-a-non-existing-direction. +- [Developer central](Developer-Central) - Main-hub-for-all-technical-developer-and-coding-information. +- [Dialogues in events](Dialogues-in-events) - Adding-dialogues-using-the-in-game-Python-system +- [Directory overview](Directory-Overview) - Shows-where-everything-is-in-the-codebase. +- [Docs refactoring](Docs-refactoring) - A page about Docs refactoring. +- [Dynamic in game map](Dynamic-In-Game-Map) - Tutorial-for-making-a-dynamically-updating-map +- [Eveditor](EvEditor) - Describes-the-use-of-the-Line-editor +- [Evennia api](Evennia-API) - The-top-level-evennia-API-module. +- [Evennia for diku users](Evennia-for-Diku-Users) - Introduction-of-Evennia-for-users-of-the-Diku-codebase +- [Evennia for mush users](Evennia-for-MUSH-Users) - Soft-introduction-of-Evennia-for-MUSH-users +- [Evennia for roleplaying sessions](Evennia-for-roleplaying-sessions) - A page about Evennia for roleplaying sessions. +- [Evennia game index](Evennia-Game-Index) - Connecting-the-game-to-the-Evennia-game-index +- [Evennia introduction](Evennia-Introduction) - The-first-introduction-to-what-Evennia-is.-You-should-have-read-this-already. +- [Evmenu](EvMenu) - Describes-the-built-in-menu-creation-tool +- [Evmore](EvMore) - Describes-the-pager-utility +- [Execute python code](Execute-Python-Code) - How-to-run-snippets-of-Python-code-from-inside-the-game,-for-testing-and-experimenting. +- [First steps coding](First-Steps-Coding) - Tutorial-describing-the-very-first-steps-for-setting-everything-up-before-you-can-start-to-code. +- [Game planning](Game-Planning) - A-list-of-things-to-think-about-before-jumping-into-making-your-first-game. +- [Gametime tutorial](Gametime-Tutorial) - A-tutorial-on-using-tools-to-handle-game-time. +- [Getting started](Getting-Started) - Explains-how-to-download,-install-and-start-Evennia-for-the-first-time. +- [Glossary](Glossary) - Indexed-explanations-of-common-terms +- [Grapevine](Grapevine) - Connecting-your-game-to-the-Grapevine-chat-network. +- [Guest logins](Guest-Logins) - Setting-up-guest-accounts +- [Haproxy config (optional)](HAProxy-Config-(Optional)) - A page about Haproxy config (optional). +- [Help system](Help-System) - How-to-use-and-add-help-files-to-the-game. +- [Help system tutorial](Help-System-Tutorial) - Create-a-page-to-see-your-game-help-online +- [Home](index) - Wiki-front-page. +- [How to connect evennia to twitter](How-to-connect-Evennia-to-Twitter) - Connecting-your-game-to-a-twitter-account. +- [How to get and give help](How-To-Get-And-Give-Help) - Summing-up-how-to-best-get-help-or-give-it. +- [Implementing a game rule system](Implementing-a-game-rule-system) - Tutorial-giving-ideas-about-creating-a-game-rule-system +- [Inputfuncs](Inputfuncs) - These-handle-incoming-requests-from-the-client +- [Installing on android](Installing-on-Android) - Describes-how-to-install-Evennia-on-an-Android-phone +- [Internationalization](Internationalization) - How-to-modify-Evennia's-core-strings-to-use-another-language-than-English. +- [Irc](IRC) - Connecting-your-game-to-an-external-IRC-channel. +- [Learn python for evennia the hard way](Learn-Python-for-Evennia-The-Hard-Way) - A page about Learn python for evennia the hard way. +- [Licensing](Licensing) - Tells-you-how-free-you-are-to-use-Evennia-to-your-personal-whims.-Really! +- [Links](Links) - A-long-list-of-Evennia,-MU*-and-other-game-related-resources. +- [Locks](Locks) - How-to-check-for-access-and-define-what-gives-access-or-not. +- [Manually configuring color](Manually-Configuring-Color) - A-tutorial-on-how-to-make-it-so-players-can-turn-on-and-off-color-in-your-game. +- [Mass and weight for objects](Mass-and-weight-for-objects) - A-tutorial-on-how-to-add-mass-attributes-to-objects-and-calculate-total-weight-of-object-and-its-contents. +- [Messagepath](Messagepath) - Describes-the-path-messages-take-through-the-server +- [Monitorhandler](MonitorHandler) - An-explaination-of-the-monitor-handler-system-to-watch-for-attribute-changes-on-objects +- [New models](New-Models) - Expanding-the-database-with-new-models-(advanced). +- [Nicks](Nicks) - Re-naming-how-to-access-and-find-other-entities,-without-modifying-them. +- [Npc shop tutorial](NPC-shop-Tutorial) - A page about Npc shop tutorial. +- [Objects](Objects) - Describes-the-basic-Object-typeclass,-the-base-for-all-in-game-things. +- [Online setup](Online-Setup) - Goes-through-the-options-for-getting-your-game-visible-online-and-how-to-do-it. +- [Oob](OOB) - A page about Oob. +- [Parsing command arguments, theory and best practices](Parsing-command-arguments,-theory-and-best-practices) - Parsing-command-arguments-best-practices +- [Portal and server](Portal-And-Server) - The-two-processes-that-make-up-the-running-Evennia-server-are-described. +- [Profiling](Profiling) - A page about Profiling. +- [Python 3](Python-3) - A page about Python 3. +- [Python basic introduction](Python-basic-introduction) - A page about Python basic introduction. +- [Python basic tutorial part two](Python-basic-tutorial-part-two) - A page about Python basic tutorial part two. +- [Quirks](Quirks) - Some-less-than-intuitive-things-we-know-people-have-trouble-getting-their-heads-around. +- [Roadmap](Roadmap) - A-tentative-list-of-future-Evennia-milestones +- [Rss](RSS) - How-to-connect-your-game-to-an-external-RSS-feed. +- [Running evennia in docker](Running-Evennia-in-Docker) - A page about Running evennia in docker. +- [Screenshot](Screenshot) - A-screenshot-of-Evennia-running. +- [Scripts](Scripts) - Controls-time-and-can-store-data-that-has-no-in-game-existence. +- [Security](Security) - A page about Security. +- [Server conf](Server-Conf) - Some-things-to-remember-when-dealing-with-the-settings.py-file. +- [Sessions](Sessions) - Summarizes-the-use-of-Sessions. +- [Setting up pycharm](Setting-up-PyCharm) - A page about Setting up pycharm. +- [Signals](Signals) - Signals-fired-at-particular-times +- [Soft code](Soft-Code) - Details-Evennia's-position-on-using-Softcode-along-with-some-history. +- [Spawner and prototypes](Spawner-and-Prototypes) - Describing-how-to-create-objects-with-the-spawner. +- [Start stop reload](Start-Stop-Reload) - How-to-control-the-Server-and-Portal-process-from-the-terminal-and-inside-the-game. +- [Static in game map](Static-In-Game-Map) - Tutorial-for-creating-static-map-view +- [Tags](Tags) - These-are-used-to-quickly-group-and-later-retrieve-game-entities. +- [Text encodings](Text-Encodings) - Technical-discussion-about-how-to-deal-with-text-using-different-character-sets. +- [Texttags](TextTags) - Describes-the-markup-for-adding-colours-and-other-tags-to-text. +- [Tickerhandler](TickerHandler) - Used-to-repeatedly-'tick'-a-method-on-an-Object. +- [Turn based combat system](Turn-based-Combat-System) - Describes-how-to-build-a-combat-system-from-scratch +- [Tutorial aggressive npcs](Tutorial-Aggressive-NPCs) - A-tutorial-on-making-NPC's-do-things-(like-attack)-when-a-character-enters. +- [Tutorial for basic mush like game](Tutorial-for-basic-MUSH-like-game) - A-long-tutorial-for-building-a-simple-MUSH-in-Evennia,-from-scratch. +- [Tutorial npcs listening](Tutorial-NPCs-listening) - A-tutorial-on-making-NPC's-do-things-(like-reply)-when-a-character-says-something. +- [Tutorial searching for objects](Tutorial-Searching-For-Objects) - Searching-For-Objects. +- [Tutorial tweeting game stats](Tutorial-Tweeting-Game-Stats) - A-tutorial-on-tweeting-game-stats-automatically. +- [Tutorial vehicles](Tutorial-Vehicles) - Creating-vehicles +- [Tutorial world introduction](Tutorial-World-Introduction) - This-is-a-small-single-player-quest-with-code-you-can-learn-from. +- [Tutorials](Tutorials) - Overview-of-all-tutorial-type-documentation. +- [Typeclasses](Typeclasses) - The-main-technical-description-of-a-core-concept.-how-Typeclasses-are-used-and-work. +- [Understanding color tags](Understanding-Color-Tags) - A page about Understanding color tags. +- [Unit testing](Unit-Testing) - Describes-how-to-expand-the-code-with-automatic-testing-suites. +- [Updating your game](Updating-Your-Game) - Describes-how-to-update-the-source-from-the-repo-and-how-to-reset-the-database. +- [Using mux as a standard](Using-MUX-as-a-Standard) - A-policy-discussion-about-how-why-the-default-commands-look-the-way-they-do. +- [Using travis](Using-Travis) - A page about Using travis. +- [Version control](Version-Control) - A-tutorial-on-using-version-control-for-your-own-sanity-and-safety. +- [Weather tutorial](Weather-Tutorial) - A-tutorial-on-using-tickers-to-make-days-go-by. +- [Web character generation](Web-Character-Generation) - A-tutorial-for-making-a-web-based-chargen-app-for-your-game. +- [Web character view tutorial](Web-Character-View-Tutorial) - Create-a-new-web-page-displaying-character-info +- [Web features](Web-Features) - Gets-you-started-on-using-Evennia's-web-integration-abilities. +- [Web tutorial](Web-Tutorial) - Gives-examples-on-how-to-customize-the-web-interface. +- [Webclient](Webclient) - A page about Webclient. +- [Webclient brainstorm](Webclient-brainstorm) - A page about Webclient brainstorm. +- [Wiki index](Wiki-Index) - This very index. +- [Zones](Zones) - Using-Tags-to-implement-game-Zones. \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 454c5fa13a..996b9e5010 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,10 +20,17 @@ if not _no_autodoc: GAME_DIR = os.environ.get("EVGAMEDIR") if not (EV_ROOT and GAME_DIR): +<<<<<<< HEAD err = ("The EVDIR and EVGAMEDIR environment variables must be set to " "the absolute paths to the evennia/ repo and an initialized " "evennia gamedir respectively.") raise RuntimeError(err) +======= + print("The EVDIR and EVGAMEDIR environment variables must be set to " + "the absolute paths to the evennia/ repo and an initialized " + "evennia gamedir respectively.") + raise RuntimeError() +>>>>>>> master print("Evennia root: {}, Game dir: {}".format(EV_ROOT, GAME_DIR)) @@ -48,7 +55,11 @@ copyright = '2020, The Evennia developer community' author = 'The Evennia developer community' # The full version, including alpha/beta/rc tags +<<<<<<< HEAD release = '1.0-dev' +======= +release = '0.9.1' +>>>>>>> master # -- General configuration --------------------------------------------------- @@ -140,10 +151,15 @@ html_theme = 'alabaster' # sphinx-multiversion config smv_tag_whitelist = r"^$" +<<<<<<< HEAD smv_branch_whitelist = r"^master$|^develop$" # which branches to include in multi-version docs # - master, develop and vX.X branches smv_branch_whitelist = r"^master$|^develop$|^v[0-9\.]+?$" +======= +# smv_branch_whitelist = r"^static-file-docs$|^static-file-dev$" +smv_branch_whitelist = r"^master$|^v1.0$" +>>>>>>> master smv_outputdir_format = "versions" + sep + "{config.release}" diff --git a/docs/source/index.md b/docs/source/index.md index bb6a8b4bed..82b35d3e28 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -4,14 +4,13 @@ # VERSION WARNING > This is the experimental static v0.9 documentation of Evennia, _automatically_ generated from the -> [evennia wiki]() at 2020-06-12 21:01:35.429785. +> [evennia wiki](https://github.com/evennia/evennia/wiki/) at 2020-06-12 22:36:53.868703. > There are known conversion issues which will _not_ be addressed in this version - refer to > the original wiki if you have trouble. > > Manual conversion and cleanup will instead happen during development of the upcoming v1.0 > version of this static documentation. -[](Wiki-front-page.) # Evennia Documentation This is the manual of [Evennia](http://www.evennia.com), the open source Python `MU*` creation system. @@ -33,6 +32,8 @@ There is [a lengthier introduction](Evennia-Introduction) to read. You might als - The [Developer Central](Developer-Central) describes how Evennia works and is used by coders. - The [Tutorials & Examples](Tutorials) contains help pages on a step-by-step or tutorial format. - The [API](api:evennia) documentation is created from the latest source code. +- The [TOC](toc) lists all regular documentation pages. + [search]: https://www.google.com/cse/publicurl?cx=010440404980795145992:6ztkvqc46je [group]: https://groups.google.com/forum/#%21forum/evennia diff --git a/docs/source/toc.md b/docs/source/toc.md index 2fd487d440..b29740aee8 100644 --- a/docs/source/toc.md +++ b/docs/source/toc.md @@ -139,4 +139,5 @@ * [Web Tutorial](Web-Tutorial.md) * [Webclient brainstorm](Webclient-brainstorm.md) * [Webclient](Webclient.md) -* [Zones](Zones.md) \ No newline at end of file +* [Wiki Index](Wiki-Index.md) +* [Zones](Zones.md)