Add guide for requirements from #3636 #4212
Conversation
The original PR got confused about files changes. I cherry picked these from the history. Hopefully this is most of the changes Closes #3636
|
I think we've discussed most of the content changes at this point. I guess we're mostly concerned with if these files look the same as the original. A quick glance looks like things are okay though. |
| - Documenting multiple packages | ||
| - setup.py not in root directory | ||
|
|
||
| See :ref:`faq_document_package_not_at_root` |
There was a problem hiding this comment.
We can use the autosectionlabel feature here
There was a problem hiding this comment.
I'm not too concerned with the content, I'm not that author here
There was a problem hiding this comment.
Agree with Santos here so we have most of our docs using the same pattern. The ref would look like:
:ref:`faq:Can I document a python package that is not at the root of my repository?`
|
|
||
| Using the YAML configuration file | ||
| --------------------------------- | ||
| The recommended approach for specifying a pip requirements file is to use a readthedocs.yml file. |
There was a problem hiding this comment.
I'd use `readthedocs.yml` here (quotes for code)
|
|
||
|
|
||
| .. _`pip user guide`: : https://pip.pypa.io/en/stable/user_guide/#requirements-files | ||
| .. _`conda and environment.yml`: : https://conda.io/docs/user-guide/tasks/manage-environments.html |
| - Documenting multiple packages | ||
| - setup.py not in root directory | ||
|
|
||
| See :ref:`faq_document_package_not_at_root` |
There was a problem hiding this comment.
Agree with Santos here so we have most of our docs using the same pattern. The ref would look like:
:ref:`faq:Can I document a python package that is not at the root of my repository?`
| Additional Uses | ||
| ~~~~~~~~~~~~~~~ | ||
| - Documenting multiple packages | ||
| - setup.py not in root directory |
There was a problem hiding this comment.
I don't really understand this section. I think it would be better if an introduction paragraph is added instead of just a two item list with a link.
| .. code-block:: yaml | ||
|
|
||
| conda: | ||
| file: environment.yml |
There was a problem hiding this comment.
There are some weird spaces here: probably tabs mixed with spaces.
|
Cleaned this up and should be merge ready. |
The original PR got confused about files changes. I cherry picked these from the
history. Hopefully this is most of the changes
Closes #3636