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 specifying 'python setup.py build_sphinx' as an alternative build command #1857

Closed
tjanez opened this issue Dec 9, 2015 · 3 comments
Closed

Comments

@tjanez
Copy link

@tjanez tjanez commented Dec 9, 2015

According to Build Process documentation, RTD's build process runs:

sphinx-build -b html . _build/html

to build the documentation (html being replaced with the correct backend).

Would it be possible to support specifying an alternative build command, e.g.:

python setup.py build_sphinx

A nice advantage why I'm using python setup.py build_sphinx in my projects is that it allows one to avoid redefining project's project, version, release and copyright variables by specifying the following in setup.py:

    command_options={
        'build_sphinx': {
            'project': ('setup.py', name),
            'version': ('setup.py', version),
            'release': ('setup.py', release),
            'copyright': ('setup.py', copyright),
        }
    }

Using the above, these values are defined only once in a project.

@agjohnson
Copy link
Contributor

@agjohnson agjohnson commented Dec 14, 2015

I'm -0 on this change, there are several other ways around this already, and we're working in another direction to simplify the configuration process. This is also an option specific to Python, we're moving more towards language-agnostic options.

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Jan 30, 2016

Agreed. Closing this, as we pass specific configuration to the sphinx build, and supporting vanity invocations isn't a good idea for us.

@tivaliy
Copy link

@tivaliy tivaliy commented Dec 15, 2017

For some reason I need to run build as:
python setup.py build_sphinx
So is it possible to invoke command in a such way using readthedocs.yml or any other approach (configuration process)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants