Setup menu

docs/_static/css/custom.css

@@ -0,0 +1,10 @@
+/* overwrite logo dimensions */
+.wy-side-nav-search>a img.logo,
+.wy-side-nav-search .wy-dropdown>a img.logo {
+	width: 128px;
+}
+
+/* overwrite top-left serach div */
+.wy-side-nav-search {
+	background-color: #343131;
+}

docs/conf.py

@@ -55,6 +55,10 @@ templates_path = ['_templates']
 source_suffix = ['.rst', '.md']
 #source_suffix = '.rst'
 
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
 # The master toctree document.
 master_doc = 'index'
 
@@ -83,9 +87,10 @@ pygments_style = 'sphinx'
 #html_theme = 'sphinx_rtd_theme'
 html_theme = 'default'
 
-# From:
-# * https://github.com/snide/sphinx_rtd_theme#using-this-theme-locally-then-building-on-read-the-docs
+html_logo = 'img/logo.png'
 
+# From:
+# * https://github.com/snide/sphinx_png_theme#using-this-theme-locally-then-building-on-read-the-docs
 if not on_rtd:  # only import and set the theme if we're building docs locally
     import sphinx_rtd_theme
     html_theme = 'sphinx_rtd_theme'
@@ -97,21 +102,21 @@ if not on_rtd:  # only import and set the theme if we're building docs locally
 #
 # html_theme_options = {}
 # https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html#project-wide-configuration
-#html_theme_options = {
-#    'canonical_url': '',
-#    'analytics_id': '',
-#    'logo_only': False,
-#    'display_version': True,
-#    'prev_next_buttons_location': 'bottom',
-#    'style_external_links': False,
-#    #'vcs_pageview_mode': '',
-#    # Toc options
-#    'collapse_navigation': False,
-#    'sticky_navigation': True,
-#    'navigation_depth': 4,
-#    #'includehidden': True,
-#    'titles_only': False
-#}
+html_theme_options = {
+    'canonical_url': '',
+    'analytics_id': '',
+    'logo_only': False,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    #'style_external_links': False,
+    #'vcs_pageview_mode': '',
+    # Toc options
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+    'navigation_depth': 5,
+    #'includehidden': True,
+    #'titles_only': False
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -128,6 +133,9 @@ html_static_path = ['_static']
 #
 # html_sidebars = {}
 
+def setup(app):
+    app.add_stylesheet('css/custom.css')
+
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
@@ -135,12 +143,6 @@ html_static_path = ['_static']
 htmlhelp_basename = 'devilboxdoc'
 
 
-# -- Options for Markdown output ------------------------------------------------
-source_parsers = {
-    '.md': CommonMarkParser,
-}
-
-
 # -- Options for LaTeX output ------------------------------------------------
 
 latex_elements = {

docs/index.md

@@ -1,9 +0,0 @@
-.. include:: ../README.md
-
-.. toctree::
-  :caption: Quickstart
-  :maxdepth: 2
-
-  quickstart/requirements
-  quickstart/installation
-  quickstart/run

docs/index.rst

@@ -1,9 +1,103 @@
-.. include:: ../README.md
+**********************
+devilbox documentation
+**********************
+.. :hidden:
+
+.. image:: img/banner.png
+
+
 
 .. toctree::
-  :caption: Quickstart
-  :maxdepth: 2
+   :maxdepth: 2
+   :numbered:
+   :caption: Getting started
 
-  quickstart/requirements
-  quickstart/installation
-  quickstart/run
+   getting-started/installation
+   getting-started/create-env-file
+   getting-started/start-the-devilbox
+   getting-started/create-your-first-project
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Tutorials
+
+   tutorials/change-document-root
+   tutorials/change-container-versions
+   tutorials/work-inside-the-container
+   tutorials/enable-auto-dns
+   tutorials/enable-xdebug
+   tutorials/customize-vhost
+   tutorials/backup-mysql
+   tutorials/backup-pgsql
+   tutorials/backup-mongo
+   tutorials/custom-environment-variables
+   tutorials/password-protect-intranet
+   tutorials/disable-intranet
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Examples
+
+   examples/setup-cakephp
+   examples/setup-drupal
+   examples/setup-joomla
+   examples/setup-laravel
+   examples/setup-phalcon
+   examples/setup-symfony
+   examples/setup-wordpress
+   examples/setup-yii
+   examples/setup-zend
+
+
+.. toctree::
+   :caption: Global configuration
+   :maxdepth: 2
+
+   configuration-global/webserver
+   configuration-global/php
+   configuration-global/mysql
+   configuration-global/mongodb
+   configuration-global/redis
+   configuration-global/memcached
+   configuration-global/bind
+   configuration-global/devilbox-intranet
+
+.. toctree::
+   :caption: Project configuration
+   :maxdepth: 2
+
+   configuration-project/dns
+   configuration-project/auto-dns
+   configuration-project/domain
+   configuration-project/custom-vhost
+
+
+.. toctree::
+   :caption: Configuration files
+   :maxdepth: 2
+
+   configuration-files/env-file
+   configuration-files/apache-conf
+   configuration-files/nginx-conf
+   configuration-files/php-ini
+   configuration-files/my-cnf
+   configuration-files/bashrc
+   configuration-files/vhost-gen
+
+
+.. toctree::
+   :caption: Advanced
+   :maxdepth: 2
+
+   advanced/technical
+   advanced/hacking
+
+
+.. toctree::
+   :caption: Support
+   :maxdepth: 2
+
+   support/faq
+   support/contributing

docs/index.rst.old

@@ -0,0 +1,20 @@
+.. devilbox documentation master file, created by
+   sphinx-quickstart on Sat Mar 10 11:28:55 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to devilbox's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`