-
-
Notifications
You must be signed in to change notification settings - Fork 143
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 custom homepage intro #53
Comments
Besides module-level docstrings rendering before the API reference, we support I.e., in your main module: """
Some introductory text ...
.. include:: ../README.md
"""
... |
Thanks that definitely helps. I have some html in my markdown and it looks like it has some trouble formatting it. Any tips? |
Should be fixed in master. 😳 Thanks! |
Thanks! That is definitely better. There is still some abnormal formatting though. From this markdown source code
|
Should be fixed in master. Thanks again! And keep them coming! 😆 |
Nice, thanks for all the quick responses. 👍 |
It would be nice if the homepage allowed some more context to be written. For example, passing the path to an arbitrary markdown file, such as the README.md, or any other arbitrary content.
Example call:
The text was updated successfully, but these errors were encountered: