Update readme

docs/source/api/evennia.contrib.awsstorage.rst

@@ -0,0 +1,27 @@
+evennia.contrib.awsstorage package
+==================================
+
+.. automodule:: evennia.contrib.awsstorage
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+evennia.contrib.awsstorage.aws\_s3\_cdn module
+----------------------------------------------
+
+.. automodule:: evennia.contrib.awsstorage.aws_s3_cdn
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+evennia.contrib.awsstorage.tests module
+---------------------------------------
+
+.. automodule:: evennia.contrib.awsstorage.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

docs/source/api/evennia.web.api.rst

@@ -0,0 +1,59 @@
+evennia.web.api package
+=======================
+
+.. automodule:: evennia.web.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+evennia.web.api.filters module
+------------------------------
+
+.. automodule:: evennia.web.api.filters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+evennia.web.api.permissions module
+----------------------------------
+
+.. automodule:: evennia.web.api.permissions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+evennia.web.api.serializers module
+----------------------------------
+
+.. automodule:: evennia.web.api.serializers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+evennia.web.api.tests module
+----------------------------
+
+.. automodule:: evennia.web.api.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+evennia.web.api.urls module
+---------------------------
+
+.. automodule:: evennia.web.api.urls
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+evennia.web.api.views module
+----------------------------
+
+.. automodule:: evennia.web.api.views
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

docs/source/conf.py

@@ -35,6 +35,9 @@ extensions = [
     "sphinx.ext.githubpages",
 ]
 
+source_suffix = ['.md', '.rst']
+master_doc = 'index'
+
 # make sure sectionlabel references can be used as path/to/file:heading
 autosectionlabel_prefix_document = True
 
@@ -58,9 +61,9 @@ smv_tag_whitelist = r"^$"
 
 # -- Options for HTML output -------------------------------------------------
 
-html_theme = "alabaster"
-# html_theme = "standford_theme"
-# html_theme_path = [sphinx_theme.get_html_theme_path("stanford_theme")]
+# html_theme = "alabaster"
+html_theme = "stanford_theme"
+html_theme_path = [sphinx_theme.get_html_theme_path("stanford_theme")]
 
 # Custom extras for sidebar
 html_sidebars = {
@@ -79,27 +82,53 @@ html_favicon = "_static/favicon.ico"
 pygments_style = "sphinx"
 
 
+# -- Options for LaTeX output ------------------------------------------------
+# experimental, not working well atm
+
+latex_engine = 'xelatex'
+latex_show_urls = 'footnote'
+latex_elements = {
+    'papersize': 'a4paper',
+    'fncychap': r'\usepackage[Bjarne]{fncychap}',
+    'fontpkg': r'\usepackage{times,amsmath,amsfonts,amssymb,amsthm}',
+    'preamble': r'''
+        \usepackage[utf8]{fontenc}
+        \usepackage{amsmath,amsfonts,amssymb,amsthm}
+        \usepackage[math-style=literal]{unicode-math}
+        \usepackage{newunicodechar}
+        \usepackage{graphicx}
+    '''
+}
+latex_documents = [
+    (master_doc,  'main.tex', 'Sphinx format', 'Evennia', 'report'),
+    ("toc", 'toc.tex', 'TOC', 'Evennia', 'report')
+]
+
+
 # -- Recommonmark ------------------------------------------------------------
 # allows for writing Markdown and convert to rst dynamically
 
 # reroute to github links or to the api
 
-_github_code_root = "https://github.com/evennia/evennia/blob/master/"
+_github_code_root = "https://github.com/evennia/evennia/blob/"
 _github_doc_root = "https://github.com/evennia/tree/master/docs/sources/"
 _github_issue_choose = "https://github.com/evennia/evennia/issues/new/choose"
 
 
 def url_resolver(url):
-    urlstart = "github:"
+    githubstart = "github:"
     apistart = "api:"
-    choose_issue = ("feature-request", "report-bug", "issue")
+    choose_issue = ("feature-request", "report-bug", "issue", "bug-report")
 
     if url.lower().strip() in choose_issue:
         return _github_issue_choose
-    elif url.startswith(urlstart):
-        return _github_code_root + url[len(urlstart) :]
+
+    elif url.startswith(githubstart):
+        urlpath = url[len(githubstart):]
+        if not (urlpath.startswith("develop/") or urlpath.startswith("master")):
+            urlpath = "master/" + urlpath 
+        return _github_code_root + urlpath
     elif url.startswith(apistart):
-        print("api: -> api ref")
         return "api/" + url[len(apistart) :] + ".html"
     return url
     # else:

docs/source/index.md

@@ -9,10 +9,81 @@
 > For now you are best off using the original wiki, or the less changing v0.9.1
 > of these docs. You have been warned.
 
+```sidebar:: An important sidebar
+
+  - Extra features
+  - Another feature 
+
+  Third feature: 
+    Stuff to do 
+
+  Fourth feature:
+    Even more.
+```
+
 # Evennia Documentation
 
 This is the manual of [Evennia](http://www.evennia.com), the open source Python
-`MU*` creation system.
+`MU*` creation system. A link to the [feature-request](issue)
+
+```note::
+
+  This is a particular note.
+
+```warning:: This is an important thing!
+  Especially this.
+```
+
+```important:: This is an interesting thing!
+
+  More text here!
+
+  And here.
+```
+
+```seealso:: This is good to look at too.
+  This in particular
+```
+
+```versionadded:: 1.0
+
+  This feature was added here
+
+```
+
+```deprecated:: 1.0
+  Use this thing instead.
+```
+
+```code-block:: python
+     :emphasize-lines: 6-7,12
+     :caption: An example code-block with everything turned on.
+     :name: Full code-block example
+
+     # Comment line
+     from evennia import Command 
+
+     class MyCommand(Command):
+       """
+       Usage: 
+          cmd x
+       """
+       key = "cmd"
+
+       def func(self):
+         self.caller.msg(self.args)
+```
+
+```markdown
+     # Comment line
+     import System
+     System.run_emphasis_line
+     # Long lines in code blocks create a auto horizontal scrollbar
+     System.exit!
+
+```
+
+<div style="clear: right;"></div>
 
 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).