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

[DOCUMENTATION] "make clean" deletes project homepage #529

Open
spoeschel opened this issue Jan 22, 2020 · 3 comments
Open

[DOCUMENTATION] "make clean" deletes project homepage #529

spoeschel opened this issue Jan 22, 2020 · 3 comments

Comments

@spoeschel
Copy link
Collaborator

The make clean command in the docs/ folder deletes everything within its build/ subfolder - including the project homepage and the EBU logo. To address this in a simple way and to also separate this static content from the actual generated documentation, I propose to move the homepage/image to their parent directory i.e. to the docs/ folder.

Note that the moved location will affect a solution to #458.

@nigelmegitt
Copy link
Collaborator

This seems like a good idea. Also need to make sure that the build script for the docs that is used to make the gh-pages branch copies the right stuff across. This solution would mean it needs to selectively copy some but not all contents of the docs/ folder instead of everything. It might be an easier solution to create a separate subfolder of docs/ that contains the static non-built content, and copy that as an additional step to copying that to the build/ folder contents after building.

Or solve this and #458 by changing $BUILDDIR to /build/sphinx in the docs/Makefile and updating the links in index.html?

@spoeschel
Copy link
Collaborator Author

Ah indeed, gh-pages has also to be considered.

Or solve this and #458 by changing $BUILDDIR to /build/sphinx in the docs/Makefile and updating the links in index.html?

[furthermore, the third docs building example in the README has also to be adjusted]

This seems to be a more elegant solution to me (more separation between the different docs parts; no copying required, which leads to redundancy on disk), which also requires less changes. However I don't understand how this solves #458, as the homepage will still be in the parent directory of the built Sphinx docs.

@nigelmegitt
Copy link
Collaborator

Indeed, I don't think it does solve #458.

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

2 participants