feat: Set sphinx which is auto documenation tool - Githubissues

Onepredict / onebone

An Open Source Signal Processing Library for Sensor Signals about vibration, current, etc.

MIT License

18 stars 3 forks source link

feat: Set sphinx which is auto documenation tool #1

Closed kyunghwan-onepredict closed 2 years ago

kyunghwan-onepredict commented 2 years ago

Summary

Write the summary about this PR.

Set sphinx to show document page on web.

Changes

Write changes in detail.

Execute sphinx and modify sphinx config such as theme and construction of document.
Add docker file to deploy html document which sphinx create on web.
Add command to sphinx build and to make docker image on Makefile.

How to Test?

Write a way to test the changes.

sphinx-server-docker-build
sphinx-server-docker-run
Check localhost:80

Checklist

[ ] Do you pass all the tests?
[ ] Do you write the changes on document such as README?