2

I'm publishing a few Python packages internally and I would like to include API documentation, currently in .rst form, but might go for Sphinx-generated HTML in the future. I need more details than I can reasonably put into a docstring (background info, tutorial examples, etc), so I've written it out long-hand.

I have a simple distutils-based setup.py where I pull in the text files, but I'm not sure where to put them on the target system (I target Windows, Linux and Mac.)

Is there a convention in the Python world for installing API docs alongside packages? Or are docs generally assumed to only be available online?

Any ideas welcome, thanks!

Improve this question
3

1 Answer 1

Reset to default
1

Installing docs is not supported by distutils. These days it seems more important to publish them online than to install them on the target system though, so if you’re set up to use Reat The Docs or upload docs to PyPI, you’re good.

Improve this answer
Sign up to request clarification or add additional context in comments.

2 Comments

Thanks Éric, I suspected that was the case. These are internal libraries, so public repos are not an option, unfortunately :-/
You can still benefit from using Sphinx and have your CI system buld and push the docs to an internal web server. You can even use the Read The Docs code to have a company-wide RTD instance, we did that!

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.