Creating a documentation website

[christian-oreilly]

Following up on one of the items mentioned in #50, we should arrange for the IPyNiiVue documentation to be automatically generated and pushed to a doc website. Let's take inspiration from how things have been implemented for the PyLossless project.

We can start by adding the corresponding GitHub action by copying and adapting this script: https://github.com/lina-usc/pylossless/blob/main/.github/workflows/build_doc.yml

Then we can copy and adapt the main files from the docs folder https://github.com/lina-usc/pylossless/tree/main/docs

Let's also make sure that we integrate the instructions for the contributors as described in issue #96

[bcalford]

@christian-oreilly I have set this up similarly to how you described. Instead of just copying over the files, though, I built it from scratch using Sphinx documentation. This is laid out in #99.

The doc site is currently set up with information mostly from the READ ME. Before it is deployed, I think more information should be added. Looking through the pylossless site, I like the idea of having some tutorials for the provided examples. Additionally, perhaps explanations for simple functions like load_drawings, pen_value, etc. I am not too familiar with what doc sites usually entail but I think info like that is common. What do you think we should include?

[christian-oreilly]

@bcalford It might be a good idea to merge a PR that creates a basic website and then have other PRs that add some additional stuff, rather than making a monster PR with everything. As you may see in #99, I think it should probably be cleaned up by removing the build folder from git. Note that every public function, class, and attribute (all those not starting with _) should have a docstring. Sphinx fetches these docstrings to create the API documentation website. That provides a solid documentation foundation. Then, tutorials and things like instructions for contributors can be added on top of that as separate PR. For this project, the Demo themselves will act as a good basis for "tutorials", but we could definitely add some tutorials. I would suggest merging the PR #99, deploying the website so that we can browse it, and then assessing what we feel is missing or what can be added, and creating separate tickets for these items so that we can attack them one piece at a time.