Skip to content

Commit d12a7b6

Browse files
bessmanbessman
committed
Update API docs to reflect new package structure
1 parent 2ff4ed3 commit d12a7b6

File tree

8 files changed

+182
-230
lines changed

8 files changed

+182
-230
lines changed

‎docs/PSL.SENSORS.rst

Lines changed: 0 additions & 126 deletions
This file was deleted.

‎docs/PSL.rst

Lines changed: 0 additions & 85 deletions
This file was deleted.

‎docs/conf.py

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# -*- coding: utf-8 -*-
22
#
33
# PSLab documentation build configuration file, created by
4-
# sphinx-quickstart
4+
# sphinx-quickstart
55
#
66
# This file is execfile()d with the current directory set to its
77
# containing dir.
@@ -35,6 +35,7 @@
3535
'sphinx.ext.todo',
3636
'sphinx.ext.viewcode',
3737
'sphinx.ext.mathjax',
38+
'sphinx.ext.napoleon',
3839
]
3940

4041
mathjax_path = 'file:///usr/share/javascript/mathjax/MathJax.js'
@@ -55,17 +56,17 @@
5556

5657
# General information about the project.
5758
project = u'FOSSASIA PSLab'
58-
copyright = u'2016, Praveen Patil, Jithin BP'
59-
author = u' Praveen Patil, Jithin BP'
59+
copyright = u'2021, FOSSASIA'
60+
author = u'FOSSASIA Developers'
6061

6162
# The version info for the project you're documenting, acts as replacement for
6263
# |version| and |release|, also used in various other places throughout the
6364
# built documents.
6465
#
6566
# The short X.Y version.
66-
version = u'1.0'
67+
version = u'2.0'
6768
# The full version, including alpha/beta/rc tags.
68-
release = u'1.0.5'
69+
release = u'2.0.0'
6970

7071
# The language for content autogenerated by Sphinx. Refer to documentation
7172
# for a list of supported languages.
@@ -146,7 +147,7 @@
146147
# Add any paths that contain custom static files (such as style sheets) here,
147148
# relative to this directory. They are copied after the builtin static files,
148149
# so a file named "default.css" will overwrite the builtin "default.css".
149-
html_static_path = ['_static']
150+
# html_static_path = ['_static']
150151

151152
# Add any extra paths that contain custom files (such as robots.txt or
152153
# .htaccess) here, relative to this directory. These files are copied
@@ -209,7 +210,7 @@
209210
# html_search_scorer = 'scorer.js'
210211

211212
# Output file base name for HTML help builder.
212-
htmlhelp_basename = 'SEELdoc'
213+
htmlhelp_basename = 'pslab-python-doc'
213214

214215
# -- Options for LaTeX output ---------------------------------------------
215216

@@ -231,8 +232,8 @@
231232
# (source start file, target name, title,
232233
# author, documentclass [howto, manual, or own class]).
233234
latex_documents = [
234-
(master_doc, 'PSL.tex', u'PSL Documentation',
235-
u'Praveen Patil, Jithin BP', 'manual'),
235+
(master_doc, 'pslab-python.tex', u'pslab-python Documentation',
236+
u'FOSSASIA Developers', 'manual'),
236237
]
237238

238239
# The name of an image file (relative to this directory) to place at the top of
@@ -261,7 +262,7 @@
261262
# One entry per manual page. List of tuples
262263
# (source start file, name, description, authors, manual section).
263264
man_pages = [
264-
(master_doc, 'psl', u'PSL Documentation',
265+
(master_doc, 'pslab-python', u'pslab-python Documentation',
265266
[author], 1)
266267
]
267268

@@ -275,8 +276,8 @@
275276
# (source start file, target name, title, author,
276277
# dir menu entry, description, category)
277278
texinfo_documents = [
278-
(master_doc, 'PSL', u'PSL Documentation',
279-
author, 'PSL', 'One line description of project.',
279+
(master_doc, 'pslab-python', u'pslab-python Documentation',
280+
author, 'pslab-python', 'One line description of project.',
280281
'Miscellaneous'),
281282
]
282283

‎docs/index.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,14 @@
33
contain the root `toctree` directive.
44
55
Welcome to PSLab's documentation!
6-
================================
6+
=================================
77

88
Contents:
99

1010
.. toctree::
1111
:maxdepth: 4
1212

13-
PSL.interface
14-
PSL.Peripherals.I2C_class
15-
PSL.Peripherals.SPI_class
16-
PSL.Peripherals.MCP4728_class
17-
PSL.Peripherals.NRF24L01_class
18-
PSL.Peripherals.NRF_NODE
13+
pslab
1914

2015

2116
Indices and tables

‎docs/pslab.bus.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
pslab.bus package
2+
=================
3+
4+
Module contents
5+
---------------
6+
7+
.. automodule:: pslab.bus
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
Submodules
13+
----------
14+
15+
pslab.bus.i2c module
16+
--------------------
17+
18+
.. automodule:: pslab.bus.i2c
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/pslab.external.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
pslab.external package
2+
======================
3+
4+
Module contents
5+
---------------
6+
7+
.. automodule:: pslab.external
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
Submodules
13+
----------
14+
15+
pslab.external.motor module
16+
---------------------------
17+
18+
.. automodule:: pslab.external.motor
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy