Skip to content

Document that RTD uses rel branch for production #2583

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

Closed
zabeloliver opened this issue Jan 9, 2017 · 4 comments
Closed

Document that RTD uses rel branch for production #2583

zabeloliver opened this issue Jan 9, 2017 · 4 comments
Labels
Needed: documentation Documentation is required

Comments

@zabeloliver
Copy link

Hi, i'd like to add a new builder for doxygen documentation (but native, not with breath). Since there are a lot of branches like real/relcorp which a far ahead of master, i'd like to know, which branch to choose for development.

Thanks in advance!
Oli

@ericholscher
Copy link
Member

Thanks for your interest. We likely wouldn't include a doxygen builder in code, but we'd be happy to make it easy to implement as a third party builder, with a good API in RTD. We'd also be happy to list the extension in our docs! :)

The main site is deployed from rel, which shouldn't be ahead of master.

@alyjak
Copy link

alyjak commented Jan 11, 2017

Note that there are a few sphinx extensions for integrating doxygen content, notably https://github.com/michaeljones/breathe, you might want to check that out before starting from scratch.

@humitos
Copy link
Member

humitos commented Mar 8, 2017

Should I close this issue? The original question was answered (regarding to the branch) 😁

Do you want to continue the discussion about how to do/implement it here? If so, we should change the title of the issue since it will be confusing.

@ericholscher
Copy link
Member

We should probably document how we do deployments and that the rel branch is in production.

@ericholscher ericholscher changed the title Which branch for development Document that RTD uses rel branch for production Mar 9, 2017
@ericholscher ericholscher added the Needed: documentation Documentation is required label Mar 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

4 participants