Include docs in main repo and automatic deploy using github actions

[gnzng]

This PR will create the docs for every update in the master branch, as it was discussed as an option in #20. I tested it in the master branch of my fork (https://github.com/gnzng/cdtools/actions/runs/13619770916). The build from docs from the workflow can be found here: https://gnzng.github.io/cdtools/

small but import addition for all mac users:

• a097dd5 adding the hidden MacOS file .DS_Store to the .gitignore

[gnzng]

I probably went to PR it a little too early, many of the copied files we probably don't need to have them mirrored in the repo.

[gnzng]

From how it is setup now it can be directly deployed from the actions without saving or uploading the build

[allevitan]

Is there more you'd like to do before we review and merge?

[gnzng]

I think it is a good start for building and deploying the docs from this repo. I think it would be good to have different doc versions for different published versions (e.g. like numpy does https://numpy.org/doc/2.2/), but I don't have any experience in how to change it in this direction and how much time and effort would be. Ill look into that at some point in time, because it will be useful for another project as well.

[allevitan]

So, to be honest I don't fully understand how github actions work, so my review here is limited to checking that the test version on the tracking branch is working.

But, because this doesn't affect the code, just the docs, I feel safe merging it into master and then dealing with any further issues that appear in a subsequent PR.

Thanks a ton for all this work! I think this is going to be super useful.