Skip to content
This repository has been archived by the owner on Jul 22, 2022. It is now read-only.

Commit

Permalink
Sphinx update
Browse files Browse the repository at this point in the history
  • Loading branch information
freedomofkeima committed Jan 11, 2017
1 parent b7b7acd commit 1a7e7cc
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ maidchan/config.py
database.db

# Sphinx docs
docs/_build/
docs/_build*

5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Maid-chan name is inspired from [Sakurasou's Artificial Intelligence](http://sakurasounopetnakanojo.wikia.com/wiki/Maid).

If you have any other ideas, I am accepting contributions :)
If you have any other ideas, I am accepting contributions :) For developers, you could access [Sphinx documentation here](https://messenger-maid-chan.readthedocs.io/) [In Progress].

## How to Run

Expand Down Expand Up @@ -84,5 +84,4 @@ All time-related features are currently handled in **UTC+9 (Japan Time)**.

This project itself is licensed under MIT License. All images are owned by their respective creators.

Last Updated: January 10, 2017

Last Updated: January 11, 2017
14 changes: 10 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,12 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import sys

cwd = os.getcwd()
project_root = os.path.dirname(cwd)
sys.path.insert(0, project_root)


# -- General configuration ------------------------------------------------
Expand All @@ -30,7 +33,10 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = [
'sphinx.ext.autodoc',
# 'sphinx.ext.viewcode'
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
15 changes: 11 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,25 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Maid-chan Messenger Bot's documentation!
===================================================
Maid-chan Messenger Bot
=======================

Maid-chan name is inspired from `Sakurasou's Artificial Intelligence`_.

This documentation is intended for developers.

For users who are interested in using Maid-chan features, please ask me directly and head to `Maid-chan Facebook Page`_.

.. toctree::
:maxdepth: 2
:caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _Sakurasou's Artificial Intelligence: http://sakurasounopetnakanojo.wikia.com/wiki/Maid
.. _Maid-chan Facebook Page: https://www.facebook.com/maidchan2/

0 comments on commit 1a7e7cc

Please sign in to comment.