Skip to content

/ cylc-doc

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

Jump to bottom

Put all build-generated artefacts on built #49

Closed
kinow opened this issue Aug 1, 2019 · 3 comments
Closed

Put all build-generated artefacts on built #49

kinow opened this issue Aug 1, 2019 · 3 comments
Labels
question

Comments

@kinow
Copy link
Member

@kinow kinow commented Aug 1, 2019

I noticed that when I run make html singlehtml, the documentation appears to be generated under build/sphinx directory, but it looks like it also creates some directories under the doc.

If we run python setup.py bdist, then the bdist distribution package would go under build/bdist.linux-x86_64 or so. Since we have the sphinx folder being created under build, and setuptools is using that directory as well, then maybe we could stop using doc too?

Or is there a reason for the need of another folder for building the documentation?
@kinow kinow added the question label Aug 1, 2019
@oliver-sanders
Copy link
Member

@oliver-sanders oliver-sanders commented Aug 6, 2019

The documentation should be built into doc/<version>.

I have no idea why you are seeing things in build/sphinx, that directory doesn't exist for me before or after a build:

$ make clean html singlehtml
$ find . -name 'build'
$ find . -name 'sphinx'
$ find . -name '_build'
@kinow
Copy link
Member Author

@kinow kinow commented Aug 7, 2019

Oh, you are right, make clean html singlehtml gives me no build directory, only the doc folder. I must have had some old folder there. And nothing appears now in git status. Funny 😕

Only way to get the build directory now is python setup.py bdist/install/etc. Closing it, sorry!
@kinow kinow closed this Aug 7, 2019
@oliver-sanders
Copy link
Member

@oliver-sanders oliver-sanders commented Aug 7, 2019

No probs, probably an artifact of all the stuff I moved, good old git clean to the rescue!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
question
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@kinow @oliver-sanders
You can’t perform that action at this time.