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

Automatically updated CLI documentation on Readthedocs #1047

Merged
merged 10 commits into from
Dec 7, 2022
Merged

Conversation

linglp
Copy link
Contributor

@linglp linglp commented Dec 5, 2022

Related to #1038

@milen-sage the workflow that Tom has (see here) could only publish documentation to github pages. But I noticed that readthedocs could let you publish documentation to readthedocs if you manually import the package and configure the webhook (without linking the project to your own github account).

More relevant documentation could be found here:

@linglp
Copy link
Contributor Author

linglp commented Dec 5, 2022

For testing purpose, currently the docs would get automatically updated whenever there's a push request to develop-docs branch. But we could change the default branch on readthedocs (see Advanced setting here: https://readthedocs.org/dashboard/schematicpy/advanced/) to look at develop branch once develop-docs branch gets merged.

The documentation could be found here: https://schematicpy.readthedocs.io/en/latest/

@linglp linglp requested a review from GiaJordan December 7, 2022 20:32
@linglp linglp merged commit e1e2abd into develop Dec 7, 2022
@linglp linglp deleted the develop-docs branch December 7, 2022 22:05
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