Docs

Stats Cog

.codacy.yml

@@ -2,6 +2,5 @@
 exclude_paths:
   - Dockerfile
   - "data/**"
-  - "docs/**"
   - ".github/**"
   - "**/*.yml"

.dockerignore

@@ -4,5 +4,4 @@
 **/*.pot
 /.gitignore
 /LICENSE
-/.github/
-/docs/
+/.github/

.github/README.md

@@ -1,6 +1,7 @@
 # Shiro.py - Work in progress
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d668927a72f14c19b23ca9a0ed71fb20)](https://www.codacy.com/app/MrSpinne/Shiro.py?utm_source=github.com&utm_medium=referral&utm_content=MrSpinne/Shiro.py&utm_campaign=Badge_Grade)
 [![Build Status](https://travis-ci.org/MrSpinne/Shiro.py.svg?branch=master)](https://travis-ci.org/MrSpinne/Shiro.py)
+[![Documentation Status](https://readthedocs.org/projects/shiropy/badge/?version=latest)](https://docs.shiro.pro/en/latest/?badge=latest)
 [![Crowdin](https://badges.crowdin.net/shiro-py/localized.svg)](https://translate.shiro.pro)
 
 ![Python Version](https://img.shields.io/badge/python-3.7-blue)

Dockerfile

@@ -1,5 +1,5 @@
 FROM python:3.7
-MAINTAINER MrSpinne <spinningplays.gaming@gmail.com>
+MAINTAINER MrSpinne <contact@shiro.pro>
 
 COPY . .
 RUN pip install -r requirements.txt

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Shiropy
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 5fb77e963d9ea67d4fc1e1376f790e69
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,20 @@
+.. Shiro.py documentation master file, created by
+   sphinx-quickstart on Thu Aug 29 17:46:28 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Shiro.py's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`