Doc update - Githubissues

pytorch / torcharrow

High performance model preprocessing library on PyTorch

https://pytorch.org/torcharrow/beta/index.html

BSD 3-Clause "New" or "Revised" License

649 stars 79 forks source link

Doc update #385

Closed bearzx closed 2 years ago

bearzx commented 2 years ago

Changes in this PR:

Put doc build and deploy into a separate workflow, so it doesn't run every time with a push. It also uploads the docs to the beta folder, which is accordingly created and linked in gh-pages branch.
Added template parameters in the .rst files as @NivekT suggested.
For the istring_column.StringMethods for now the best I could do is just removing the torcharrow prefix. I feel it's sort of related to the fact that StringMethods is not part of StringColumn. Importing it with an alias did not seem to work. We can keep investigating to find the best way to present it in the doc.

facebook-github-bot commented 2 years ago

@bearzx has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

facebook-github-bot commented 2 years ago

@bearzx has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

facebook-github-bot commented 2 years ago

@bearzx has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D37261768

facebook-github-bot commented 2 years ago

@bearzx has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D37261768

bearzx commented 2 years ago

Some changes to the gh-pages branch is needed to make this work properly.

We need a folder main where the nightly version (or just commits of main for now) should deploy to. You can move all the content there (except the 0.1.0 folder) into that folder.

The 0.1.0 branch should track changes from the release branch.

Add a HTML file that redirects to beta and a list of versions.

Add a symlink from beta to 0.1.0.

yep gonna do that next ... I actually added some last Friday but then they were overwritten by the nightly doc deploy :D