Include Documentation - Githubissues

worldbank / REaLTabFormer

A suite of auto-regressive and Seq2Seq (sequence-to-sequence) transformer models for tabular and relational synthetic data generation.

https://worldbank.github.io/REaLTabFormer/

MIT License

203 stars 23 forks source link

Include Documentation #20

Closed g4brielvs closed 1 year ago

g4brielvs commented 1 year ago

Hi @avsolatorio! First, thanks so much for this great package! This PR includes:

Documentation to be published at https://worldbank.github.io/realtabformer (after merging), containing examples and API reference (using sphinx-apidoc).
CI to publish to GitHub Pages (only on releases/tags) automatically.

g4brielvs commented 1 year ago

@avsolatorio Thanks so much! Sorry I didn't realize you had adopted the gitflow strategy (main/develop). If possible, we would have to merge the main into develop when appropriate. Also, just a heads up the documentation will only go live on the next release/tag. Thanks! 🙏

avsolatorio commented 1 year ago

@avsolatorio Thanks so much! Sorry I didn't realize you had adopted the gitflow strategy (main/develop). If possible, we would have to merge the main into develop when appropriate. Also, just a heads up the documentation will only go live on the next release/tag. Thanks! 🙏

Nope, you did the right thing! I am transitioning all my projects to GitHub Flow. 😀 And noted on the documentation release. This is a really helpful contribution!