search

huawei-noah / trustworthyAI

Trustworthy AI related projects
Apache License 2.0
970 stars 217 forks source link

Create initial documentation website #144

Open shaido987 opened 10 months ago

shaido987 commented 10 months ago

There is no website with documentation available for gCastle so we want to add one.

For similar open-source projects, using "read the docs" to host and sphinx to generate the documentation itself seems to be the most common approach. Something similar to https://github.com/median-research-group/LibMTL or https://github.com/LongxingTan/Time-series-prediction/tree/master would be a great start.

AlxndrMlk commented 10 months ago

@shaido987 - so you'd like to use Sphinx to auto-generate the docs?

shaido987 commented 10 months ago

@AlxndrMlk Yes. Not sure if it's doable with out current docstrings or not as none of us have any experience with sphinx. But should be worth a try to get a working foundation for a documentation website.

AlxndrMlk commented 10 months ago

@shaido987 - I'd require making the docstrings sphinx-compatible. Seems doable.

Happy to help adapting them within my capacity.

shaido987 commented 10 months ago

@AlxndrMlk Do you know if there are any larger changes required? The overall format should be ok using either the numpydoc or the sphinxcontrib.napoleon extension (not sure about the trade-offs here but both should provide support for numpy style docstrings). I just noticed that the dodiscover package has something similar (and uses numpydoc): https://github.com/py-why/dodiscover/blob/main/doc/conf.py

AlxndrMlk commented 10 months ago

It's pretty straightforward, @shaido987

You can check this tutorial for more details, it's really good: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/index.html

PS: I didn't know about numpydoc - thanks for sharing.