search

kuchtact / WiPPLPy

Easily access data from plasma devices in the Wisconsin Plasma Physics Laboratory (WiPPL).
https://wipplpy.readthedocs.io/en/latest/
2 stars 4 forks source link

Initialize documentation #9

Closed namurphy closed 5 months ago

namurphy commented 1 year ago

This PR was made using sphinx-quickstart.

kuchtact commented 5 months ago

@namurphy Is this ready to merge? I can't remember what we decided. Thanks for doing this though!

namurphy commented 5 months ago

Sure, I think it's ready!

If pip install sphinx has already been run and make has been installed, the docs can be built by:

  1. Entering docs/
  2. Running make html

The source files are in docs/source and the index file for the build output will be at docs/build/html/index.html.

kuchtact commented 5 months ago

You are referring to running the sphinx stuff on a personal computer, yes? Also, is there a way to make it so somebody can easily download all the dependencies they need (sphinx, numpy, etc.?)