Skip to content

Update Documentation for 5.0.0#792

Merged
aaronayres35 merged 4 commits into
gh-pagesfrom
gh-pages-5.0
Jun 15, 2021
Merged

Update Documentation for 5.0.0#792
aaronayres35 merged 4 commits into
gh-pagesfrom
gh-pages-5.0

Conversation

@aaronayres35
Copy link
Copy Markdown
Contributor

@aaronayres35 aaronayres35 commented Jun 15, 2021

This PR updates the documentation for the 5.0.0 release. Unfortunately, I realized a couple additional broken links in the built docs. I did the unorthodox thing of fixing them before building the docs for this PR. After this, I will open a PR to fix them in the docs source in the code base. I figured the release is already tagged, but we want the served docs to not have the broken links. I imagine the scenario of someone building the docs themselves not from master or the maint branch will be a rare occurrence.

The steps I took were:

git clean -ffxd
git checkout 5.0.0
python ci/edmtool.py install
edm shell -e chaco-test-3.6-null
edm install scipy pyqt5
python setup.py install
exit
# fix a couple more broken links locally.  See PR #793 / #794
python ci/edmtool.py docs
# move docs/build/html folder to my desktop
git stash # stash my fixes, this was used later for PR #793 / #794
git checkout gh-pages
git clean -ffxd
git pull
git checkout -b gh-pages-5.0
mkdir 4.8
mkdir 5.0
mv `ls -d [![:digit:]]*` 4.8/. # move old 4.8 built 
git add -u
git add 4.8/
git commit -m "move 4.8 build docs into a 4.8 folder"
# move html folder containing built docs into cwd
rsync -r --exclude="\.buildinfo" html/* 5.0/  # put 5.0 built docs in 5.0 folder
rm -r html
cp -r 5.0/* .
git add .
git commit -m "add 5.0 built docs to 5.0 folder and root directory"

To test:
python -m http.server

@aaronayres35
Copy link
Copy Markdown
Contributor Author

It looks like appveyor / travis are required on the chaco gh-pages branch? We won't be able to merge this PR until that is turned off

Copy link
Copy Markdown
Contributor

@rahulporuri rahulporuri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly LGTM - the link in the tools ImageInspectorTool still seems broken on this PR though.

@rahulporuri
Copy link
Copy Markdown
Contributor

It looks like appveyor / travis are required on the chaco gh-pages branch? We won't be able to merge this PR until that is turned off

I updated the settings - gh-pages now requires no status checks

@aaronayres35
Copy link
Copy Markdown
Contributor Author

Mostly LGTM - the link in the tools ImageInspectorTool still seems broken on this PR though.

🤦 nice catch, thank you! I will fix this before merging this PR. Also, looking closer I have no idea why that is a :download: rather than just a link to the code on github like we do elsewhere in the docs... I will fix the link here, it can be updated more later (that whole Tools page is very much still a WIP)

@aaronayres35 aaronayres35 merged commit 401a7dd into gh-pages Jun 15, 2021
@rahulporuri rahulporuri deleted the gh-pages-5.0 branch June 16, 2021 12:26
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