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

docsite/build-site.py should use full path to index.html #4951

Closed
wants to merge 1 commit into from
Closed

docsite/build-site.py should use full path to index.html #4951

wants to merge 1 commit into from

Conversation

gundalow
Copy link
Contributor

Before

foo@bar:~/ansible/mine/docsite$ ./build-site.py
~~snip~~
build succeeded, 1 warning.
gvfs-open: ~/ansible/mine/docsite/index.html: error opening location: Error when getting information for file '~ansible/mine/docsite/index.html': No such file or directory
foo@bar:~/ansible/mine/docsite$

After

Webpage opens in browser
Also tested "make webdocs" from top level

Also fixed minor typo in comment. Apologies if you prefer that in a separate change, let me know, I thought this would be pragmatic.

Also fix minor typo in documentation
@mpdehaan
Copy link
Contributor

What problem does this fix?

The way we build the site goes through "make docs" and I haven't encountered a problem doing that, so, curious...

@gundalow
Copy link
Contributor Author

docsite/README.md informs the contributor about "make viewdocs"
which is different from toplevel "make docs" as it tries (and currently fails) to open the newly created index.html in your browser.

I believe all of the docsite makes go via build-site.py

The use case/workflow is:
hack rst files
make viewdocs
webbrowser opens with newly created html pages loaded

@mpdehaan
Copy link
Contributor

got it, thanks!

Yeah, haven't used that target for a while :)

@gundalow
Copy link
Contributor Author

Do you need any extra info, or does this just need the "docs_pull_request" label?

Let me know if you need anything else

@mpdehaan
Copy link
Contributor

As we build all of this through the makefile I don't believe we need to change anything at this time.

@mpdehaan mpdehaan closed this Dec 27, 2013
@gundalow
Copy link
Contributor Author

I believe "make webdocs" is also broken without this fix, but can not test at the moment as I'm traveling

jimi-c pushed a commit that referenced this pull request Dec 6, 2016
@ansibot ansibot added docs This issue/PR relates to or includes documentation. and removed docs_report labels Mar 1, 2018
@ansible ansible locked and limited conversation to collaborators Apr 24, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs This issue/PR relates to or includes documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants