-
-
Notifications
You must be signed in to change notification settings - Fork 411
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
CONTRIBUTION doesn't mention how to build the docs #1057
Comments
Right, we use sphinx for this, see this file for some instructions. I guess it wouldn't hurt to have the contributing document mention this indeed. Note that if you're a nix enthusiast, |
BTW, with new sphinx the documentation won't build unless you remove a line from config:
|
That's why we have https://github.com/haskell-servant/servant/blob/master/doc/requirements.txt |
I see, though |
I use virtualenv (as well as readthedocs) and https://github.com/haskell-servant/servant/blob/master/doc/building-the-docs mentions it. Seems we don't have `html` target in `Makefile` though. Cannot check what's up now. That needs fix indeed.
Pipenv isn't supported on readthedocs based on readthedocs/readthedocs.org#3181
Unfortunately I don't know the current best practicies of development in Python, but I'm pretty sure that relying on global installations is not one. (And IIRC there aren't anything like cabal's dependency solver, so sticking to pinned versions (which work) is the best approach).
I'd like to read more about Python development practicies though.
…Sent from my iPhone
On 2 Feb 2019, at 14.18, Vladimír Čunát ***@***.***> wrote:
I see, though ==1.7.5 seems a bit strict requirement to me personally. This way one would end up keeping a dozen versions in each distribution. Docs built fine with 1.7.9 for us and it's a simple one-liner for 1.8.3, but if you prefer it this way...
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.
|
Actually Anyway, Adding to CI is a bonus of course, it would be nice if |
For reference, I actually use |
Wait, does nixpkgs include/build servant's |
Yes, our official package is with docs: https://github.com/NixOS/nixpkgs/blob/8ba79e5af/pkgs/development/haskell-modules/configuration-common.nix#L738 |
@vcunat that's very nice 👍 |
I used to do Python, so I made #1124 |
Can be closed, fixed. |
Thanks! |
Forgot one essential point: does it check the code in docs compiles well? If not – we should mention that in README imo @domenkozar |
We do check that the tutorial + cookbook recipes compile, in CI. |
Doing the
stack test
doesn't seem to build the docs, which is slightly inconvenient, since I can't really check if I got them right without Travis.Would be a nice addition.
The text was updated successfully, but these errors were encountered: