worldbank / template

🎩 Project Template
https://worldbank.github.io/template/
Mozilla Public License 2.0
25 stars 11 forks source link

Updates for the /README.html #59

Open Holly-Transport opened 2 months ago

Holly-Transport commented 2 months ago

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 commented 2 months ago

@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.