Skip to content

Commit cf6234d

Browse files
eteqeteq
committed
added starting point
1 parent ecd76a9 commit cf6234d

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

‎docs/conf.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@
7676
# List of patterns, relative to source directory, that match files and
7777
# directories to ignore when looking for source files.
7878
exclude_patterns.append('_templates')
79+
exclude_patterns.append('pkgtemplate.rst')
7980

8081
# Add any paths that contain templates here, relative to this directory.
8182
if 'templates_path' not in locals(): # in case parent conf.py defines it

‎docs/pkgtemplate.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
packagname -- a description of the package
2+
==========================================
3+
4+
.. automodule:: packagename
5+
6+
Introduction
7+
------------
8+
9+
Include general content that might be useful for understanding the package here
10+
11+
Getting Started
12+
---------------
13+
14+
A tutorial-oriented example of how to do common-tasks
15+
16+
17+
18+
API/Reference
19+
-------------
20+
21+
22+
.. automodapi:: packagename

0 commit comments

Comments
 (0)