FM-17 / poglink

A bot that integrates the ARK Web API with Discord.
MIT License
12 stars 4 forks source link

Create Documentation for Github Pages or ReadTheDocs #63

Open travipross opened 2 years ago

travipross commented 2 years ago

Now that the package is more mature, the README should likely be included in some surrounding documentation that outlines how the project works, as well as documents some of the internal API.

Docstrings will need to be written for most functions (though some already have docstrings). Type hints according to PEP 484 may also be of benefit at this stage to aid in automatic docstring generation by plugins.

ReadTheDocs (which is free for open source projects) is simple to set up and effective for hosting RestructuredText docuemntation generated by Sphinx. However, we could also explore or consider hosting documentation on a Github Pages site to keep things more simple. However, if using sphinx for documentation generation (and all its benefits including automatic docstring-informed API documentation), it may be easier to use RTD over Github Pages (but not impossible to use Github Pages).