Skip to content

Commit

Permalink
Added Installation and Quickstart Docs
Browse files Browse the repository at this point in the history
Added more documentation for Pore2Chip using Sphinx. Will work on module reference later.
  • Loading branch information
aramyxt committed Jan 7, 2025
1 parent 24e6c55 commit dc9646f
Show file tree
Hide file tree
Showing 41 changed files with 5,354 additions and 3,707 deletions.
13 changes: 2 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,11 @@ test_filter.py
/__pycache__
/src/pore2chip/__pycache__
/src/flow/__pycache__
/example_outputs copy
test_file.vtk
/dist_bak
dist_bak/pore2chip-0.0.1-py3-none-any.whl
dist_bak/pore2chip-0.0.1.tar.gz
dist_bak/pore2chip-0.0.2-py3-none-any.whl
dist_bak/pore2chip-0.0.2.tar.gz
dist_bak/pore2chip-0.0.3-py3-none-any.whl
dist_bak/pore2chip-0.0.3.tar.gz
requirements_bak.txt.bak
example_outputs/micromodel.vtk
isrc/pore2chip.egg-info/PKG-INFO/*
src/pore2chip/gencoord.py
src/pore2chip.egg-info
tests/results/
tests/resultspinn_*
src/pore2chip/prototype2.ipynb
dist/*
/docs/build
Binary file removed docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/build/doctrees/index.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/install.doctree
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/build/html/.buildinfo

This file was deleted.

4 changes: 0 additions & 4 deletions docs/build/html/.buildinfo.bak

This file was deleted.

23 changes: 0 additions & 23 deletions docs/build/html/_sources/index.rst.txt

This file was deleted.

51 changes: 0 additions & 51 deletions docs/build/html/_sources/install.rst.txt

This file was deleted.

Loading

0 comments on commit dc9646f

Please sign in to comment.