Closed scott-huberty closed 1 year ago
I'm making this a separate ticket from #19 because this is more about launching an initial github readthedocs website for this repository.
readthedocs
I want to launch a very basic skeleton of this documentation page so that we (maintainers) can see it, and iterate on it further.
I am developing this in a branch right now. I will open a PR to merge into main (hopefully today), which will consist of the following work.
bids.py
config.py
pipeline.py
docs
requirements_doc.txt
Once this PR is merged, we can generate the documentation page and I will close this ticket.
EDIT: by "generate", I mean launch the readthedocs page so that is accessible via URL in the web browser.
I'm making this a separate ticket from #19 because this is more about launching an initial github
readthedocswebsite for this repository.I want to launch a very basic skeleton of this documentation page so that we (maintainers) can see it, and iterate on it further.
I am developing this in a branch right now. I will open a PR to merge into main (hopefully today), which will consist of the following work.
bids.py,config.py&pipeline.pydocsfolder that will contain the documentation content.requirements_doc.txtfile in the project root, containing package requirements for making/contributing to the docs.Once this PR is merged, we can generate the documentation page and I will close this ticket.
EDIT: by "generate", I mean launch the
readthedocspage so that is accessible via URL in the web browser.