Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start writing docs. #24

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Start writing docs. #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
docstub's documentation
=======================

**Date**: |today|, **Version**: |version|

Welcome! `docstub` is a command-line tool to generate `Python`_ stub files
(i.e., PYI files) from type descriptions found in `numpydoc`_ style docstrings.

`numpy`_, `scipy`_, and the scikits follow a common convention for docstrings
that provides for consistency, while also allowing toolchains such as
`numpydoc`_ to produce well-formatted reference guides.

Our project follows the `SciPy code of conduct`_.

.. _numpy: https://numpy.org
.. _numpydoc: https://numpydoc.readthedocs.io
.. _Python: https://www.python.org
.. _scipy: https://docs.scipy.org
.. _Scipy code of conduct: https://github.com/scipy/scipy/blob/master/doc/source/dev/conduct/code_of_conduct.rst
Loading