Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation on the boilerplate #67

Open
LeoSilvaGomes opened this issue Feb 2, 2023 · 0 comments
Open

Add documentation on the boilerplate #67

LeoSilvaGomes opened this issue Feb 2, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@LeoSilvaGomes
Copy link
Contributor

No description provided.

@LeoSilvaGomes LeoSilvaGomes added the documentation Improvements or additions to documentation label Feb 2, 2023
@LeoSilvaGomes LeoSilvaGomes added this to the Sprint 5 milestone Feb 2, 2023
Bruno-Felix added a commit that referenced this issue Feb 13, 2023
* doxygen files

* doxygen files

* #46 insert box to user_guide and getting start

* (#57)(#58) Update sphinx path

* (#57)(#58) Remove /html and /xml from git monitoring

* (#57)(#58) Remove files and folders from git monitoring

* Update gitignore

* Retirando arquivo .buidinfo do monitoramento git

* #57 update config and insert files in .gitignore

* #57 Update hygia description and 'why hygia'

* (#57 #58) Increment _sources on .gitignore

* (#57 #58) Increment _sources on .gitignore

* (#57 #58) Generate the index.html for github deploy page

* (#57 #58) Change user guide for getting start

* (#57 #58) Update .gitignore

* (#57 #58) finishing the description and initial instruction about the product

* (#57 #58) Remove index Indices and tables

* (#57 #58) Take back the .html files

* (#57 #58) Update Getting Start and set init User Guide

* (#57 #58) Improve User Guide

* (#57 #58) Take back basic.css

* (#57 #58) Update Getting Start

* (#57 #58) Update User Guide

* (#57 #58) Update User Guide

* Reestructure and update the documentation

* (#57 #58) update doxygen documentation

* #67 Insert explanatory texts to assist users in running the boilerplate

* 67 update boilerplate of retrained predict

* 67 update boilerplate of yaml use

* #66 updating readme for use in pypi

* #68 documenting data_pipeline classes and functions

* #68 documenting feature_engineering classes and functions

* #68 documenting model classes and functions

* #68 documenting annotate_data classes and functions

* #68 updating title and making some adjustments

* #68 update doxygen

* #68 update and fix documentation

- Insert supported by
- Remove list of tables and index
- Insert logo in header
- Insert link to github organization
- update doxygen .xml

* #68 Change documentation format

* Fix header logo

---------

Co-authored-by: Carla Rocha <[email protected]>
Co-authored-by: Bruno-Felix <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants