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

Updates for the /README.html #59

Open
Holly-Transport opened this issue Sep 6, 2024 · 1 comment
Open

Updates for the /README.html #59

Holly-Transport opened this issue Sep 6, 2024 · 1 comment
Assignees

Comments

@Holly-Transport
Copy link
Contributor

I'm making sure we are all set with the documentation template.

I needed to make two fixes to deploy template -- would appreciate if a colleague could confirm whether these two additional steps are necessary:

(1) changed docutils version to none in the pyproject.toml file
Pasted Graphic 3

(2) Needed to remove branch protection rule on gh-pages, here:
Pasted Graphic 1

So that it looks like this:
Pasted Graphic 2

Also...

(3) We might add directions to change the repo url in the config file, so that the web book links back to the project repo, not the documentation template repo. Like this:

image
@g4brielvs
Copy link
Contributor

g4brielvs commented Sep 6, 2024

@Holly-Transport Thanks! @SahitiSarva @dmatekenya Regarding (1), please refer to this issue. For (2), the branch protection can be removed. For (3), step 3 should already address it, though it might need further clarification.

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

No branches or pull requests

4 participants