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

WIP: Add documentation. #22

Merged
merged 5 commits into from
Aug 24, 2021
Merged

WIP: Add documentation. #22

merged 5 commits into from
Aug 24, 2021

Conversation

csukuangfj
Copy link
Collaborator

@csukuangfj csukuangfj commented Aug 23, 2021

A preview is available by visiting the following address:

https://icefall.readthedocs.io/en/latest/


Screenshots of the documentation:

Screen Shot 2021-08-23 at 8 25 25 PM

Screen Shot 2021-08-23 at 8 25 44 PM

Screen Shot 2021-08-23 at 8 31 55 PM

@danpovey
Copy link
Collaborator

That looks great!
The colab notebook is a nice touch.

@csukuangfj
Copy link
Collaborator Author

That looks great!
The colab notebook is a nice touch.

Shall we choose a dedicated place to save such notebooks, say, a GitHub repo?

@danpovey
Copy link
Collaborator

Regarding the colab notebooks: I'm OK with that as long as it doesn't make it harder to get things done... but maybe not a short-term/urgent priority?

@csukuangfj
Copy link
Collaborator Author

Regarding the colab notebooks: I'm OK with that as long as it doesn't make it harder to get things done... but maybe not a short-term/urgent priority?

Yeah, it's not urgent. If later we have lots of notebooks, we can start to find a place to put them.

@csukuangfj
Copy link
Collaborator Author

Merging so that @pkufool can also work on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants