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

Support 'base' in ConfigWrapper and Sphinx backend #2646

Closed
agjohnson opened this issue Feb 16, 2017 · 7 comments
Closed

Support 'base' in ConfigWrapper and Sphinx backend #2646

agjohnson opened this issue Feb 16, 2017 · 7 comments
Labels
Sprintable Small enough to sprint on

Comments

@agjohnson
Copy link
Contributor

As per the spec for https://github.com/rtfd/readthedocs-build, we should support the 'base' configuration element. This logic would need to be moved from the project model and into the sphinx backend, but this makes more sense anyways.

@agjohnson agjohnson added Good First Issue Good for new contributors Sprintable Small enough to sprint on labels Feb 16, 2017
@Jigar3
Copy link
Contributor

Jigar3 commented Feb 14, 2018

@agjohnson I want to work on this issue.
Can you give me more details regarding this

@RichardLitt
Copy link
Member

@stsewd Would you be able to help with this?

@stsewd
Copy link
Member

stsewd commented Feb 15, 2018

@RichardLitt @Jigar3 I'm not familiar with the https://github.com/rtfd/readthedocs-build project, but what I understand this would be a step for moving the build process to the other library. I'm going to take a look to the other project on the next days, so hope to be more helpful then.

@stsewd
Copy link
Member

stsewd commented Mar 7, 2018

@RichardLitt well now I think I have some more experience with the other project (sorry for taking a long time).

@Jigar3 I recommend you reading the spec of the yaml file here https://github.com/rtfd/readthedocs-build/blob/master/docs/spec.rst, also https://docs.readthedocs.io/en/latest/yaml-config.html (#3685 contains more accurate docs) so you have a little more of context of what this issue is about.

From the spec:

base
The path to the root directory of the documentation that this config is about. That is usually the path that contains the conf.py file. It defaults to the directory that the readthedocs.yml file lives in. All commands for building the documentation will have the base set as working directory.

This is what the issue is about, respecting the base setting from the yaml file when executing build commands. Let me know if you need more information about the files that would need to be edited.

@stsewd
Copy link
Member

stsewd commented Mar 16, 2018

@Jigar3 are you still interested or working on this issue?

@stsewd
Copy link
Member

stsewd commented Sep 24, 2018

I think we can close this in favor of #4354

@stsewd stsewd removed the Good First Issue Good for new contributors label Sep 24, 2018
@stsewd
Copy link
Member

stsewd commented Nov 27, 2018

Closing as this isn't on our current schema, and we have the new install key which accepts a path for each installation.

@stsewd stsewd closed this as completed Nov 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Sprintable Small enough to sprint on
Projects
None yet
Development

No branches or pull requests

4 participants