Skip to content

Commit dc9646f

Browse files
committed
Added Installation and Quickstart Docs
Added more documentation for Pore2Chip using Sphinx. Will work on module reference later.
1 parent 24e6c55 commit dc9646f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+5354
-3707
lines changed

.gitignore

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,11 @@ test_filter.py
1111
/__pycache__
1212
/src/pore2chip/__pycache__
1313
/src/flow/__pycache__
14-
/example_outputs copy
15-
test_file.vtk
16-
/dist_bak
17-
dist_bak/pore2chip-0.0.1-py3-none-any.whl
18-
dist_bak/pore2chip-0.0.1.tar.gz
19-
dist_bak/pore2chip-0.0.2-py3-none-any.whl
20-
dist_bak/pore2chip-0.0.2.tar.gz
21-
dist_bak/pore2chip-0.0.3-py3-none-any.whl
22-
dist_bak/pore2chip-0.0.3.tar.gz
23-
requirements_bak.txt.bak
2414
example_outputs/micromodel.vtk
2515
isrc/pore2chip.egg-info/PKG-INFO/*
2616
src/pore2chip/gencoord.py
2717
src/pore2chip.egg-info
2818
tests/results/
2919
tests/resultspinn_*
30-
src/pore2chip/prototype2.ipynb
20+
dist/*
21+
/docs/build
-13.7 KB
Binary file not shown.

docs/build/doctrees/index.doctree

-4.7 KB
Binary file not shown.
-6.49 KB
Binary file not shown.

docs/build/html/.buildinfo

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

docs/build/html/.buildinfo.bak

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

docs/build/html/_sources/index.rst.txt

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

docs/build/html/_sources/install.rst.txt

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

0 commit comments

Comments
 (0)