-
Notifications
You must be signed in to change notification settings - Fork 43
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
Redo reference #162
Redo reference #162
Conversation
a91bd56
to
613c101
Compare
613c101
to
6fa0c7a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This reference is ✨✨✨
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@@ -1,111 +1,58 @@ | |||
""" | |||
Generate the code reference pages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about adding a comment that tell that this script is executed when running mkdocs serve -f docs/mkdocs.yml
?
@@ -18,7 +18,7 @@ Check the index on the left for a more detailed description of any symbol. | |||
| ----------------------------------------- | -------------------------------------------------------------------------------------- | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This front page is now awesome.
New docs structure
Docs now work as follows:
docs/src/reference
::: temporian.to_csv
) for them to be auto-filled with that symbols' docstring. More info here.docs/src/reference/temporian/io/to_csv.md
file exists, the reference page fortemporian.to_csv
will be generated underreference/temporian/io/to_csv/
in the docs.Tests
Added two tests:
temporian.
are exactly the ones we expectBonus
tp.core
,tp.implementation
, etc. symbols by simply doingdel core
in the init file 👀