Skip to content
This repository has been archived by the owner on Aug 11, 2023. It is now read-only.

Commit

Permalink
Update sphinx docs
Browse files Browse the repository at this point in the history
  • Loading branch information
constrict0r committed Nov 12, 2018
1 parent fb535ea commit 318f1d2
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 17 deletions.
2 changes: 1 addition & 1 deletion amanita/amanita.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
.. module:: amanita
:noindex:
:platform: Linux
:synopsis: create customizable python projects.
:synopsis: Of the mushroom, said the Caterpillar.
.. moduleauthor:: constrict0r <constrict0r@protonmail.com>
"""
Expand Down
16 changes: 2 additions & 14 deletions amanita/project.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-

"""Project creation."""
"""Creates customizable projects"""
import os
import sys
import subprocess
Expand All @@ -9,19 +9,7 @@


class Project:
"""Template to create python projects"""

# Variables for customizing the project.
direnv = False
emacs = False
pypi = False
repository = False
sphinx = False
tox = False
travis = False
venv = False
venv_path = False
web = False
"""Create python projects from simple package to web application."""

# Create the project.
def __init__(self, path, direnv=False, venv=False, venv_path=''):
Expand Down
16 changes: 16 additions & 0 deletions docs/source/amanita.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,22 @@ amanita.amanita module
:undoc-members:
:show-inheritance:

amanita.cli module
------------------

.. automodule:: amanita.cli
:members:
:undoc-members:
:show-inheritance:

amanita.project module
----------------------

.. automodule:: amanita.project
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------
Expand Down
6 changes: 4 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
# 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.
#
autodoc_mock_imports = ['click']

import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
Expand Down Expand Up @@ -65,9 +67,9 @@
# built documents.
#
# The short X.Y version.
version = '0.0.1'
version = '0.1.0'
# The full version, including alpha/beta/rc tags.
release = '0.0.1'
release = '0.1.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down

0 comments on commit 318f1d2

Please sign in to comment.