Skip to content

[Contribute] Include the Makefile, the conf.py and the sensio's sphinx extension to make testing easier. #2722

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
docteurklein opened this issue Jun 13, 2013 · 2 comments
Labels
hasPR A Pull Request has already been submitted for this issue.

Comments

@docteurklein
Copy link
Contributor

No description provided.

@wouterj
Copy link
Member

wouterj commented Aug 25, 2013

👍

This will also enable the possibility to use Travis on this repo. On the CMF docs, we enabled travis last week and I'm pretty happy with it. Travis will parse the docs using sphinx and then report any errors. That means we solve all sphinx error when a PR is opened, instead of after it.

I propose to create a pip package for fabpot's sphinx extensions, we shouldn't duplicate code here from that repo. /cc @fabpot

I actually don't know how this will work out for the online docs, @fabpot ?

And @weaverryan I would like to get your opinion about this and Travis. You can see an example in the PRs in symfony-cmf/symfony-cmf-docs

EDIT: pupet -> pip

@docteurklein
Copy link
Contributor Author

based on docs, we could use git submodules too, and script travis like that:

language: python

python:
    - "2.7"

install: "git submodule update --init"

script: make html

See http://sphinx-doc.org/extensions.html#where-to-put-your-own-extensions

@wouterj wouterj mentioned this issue Dec 16, 2013
4 tasks
weaverryan added a commit that referenced this issue Mar 20, 2014
This PR was merged into the 2.3 branch.

Discussion
----------

[WIP] Travis integration

| Q   | A
| --- | ---
| Doc fix? | no
| New docs? | no
| Applies to | all
| Fixed tickets | #2722, #3332

##### Todo

 - [x] Using sparse checkout
 - [x] Update contributing docs
 - [ ] Squashing commits
 - [ ] Activate Travis hook (@fabpot)

Commits
-------

37eb137 Update documentation
8dec729 sparse checkouts
b6f693e Added CMF
b1d9e62 Revert changes
6cad008 Updated travis config
c515613 Added .gitignore
85b1b02 Try to supress bundle doc warnings
f3cb8b1 Fixed submodules
71a2ff4 Added needed config files
d312683 Added sphinx files
@wouterj wouterj closed this as completed Jun 30, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hasPR A Pull Request has already been submitted for this issue.
Projects
None yet
Development

No branches or pull requests

2 participants