Skip to content

Commit b1c6eab

Browse files
committed
Adding docs
1 parent 1edfb1c commit b1c6eab

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ wheels/
2424
*.egg-info/
2525
.installed.cfg
2626
*.egg
27+
arrayutils.md
2728

2829
# PyInstaller
2930
# Usually these files are written by a python script from a template

docs/generating-docs.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Generating docs
2+
3+
This is just a helper file to explain how to generate docs.
4+
5+
1. `pydoc-markdown -I arrayutils -m Arr --render-toc > arrayutils.md`
6+
2. Copy/paste docs into README
7+
3. Replace `#__init__.Arr.` with `#usage.`
8+
4. Remove some of the extraneous elements at the top.

docs/publishing.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Publishing
2+
3+
This is just a helper doc with info on publishing to pypi.org.
4+
5+
1. `python -m build`
6+
2. `python -m twine upload --repository pypi dist/*`

0 commit comments

Comments
 (0)