conan-io / conan-io/docs

[Reference] Missing sections

Open
#2,943 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
125
Forks
382
Avg merge
22h 39m
Merged PRs (30d)
21

Description

* [x] Configuration files (global.conf, conandata.yaml, profiles, etc) (https://github.com/conan-io/docs/pull/2947)
* [x] Profiles (https://github.com/conan-io/docs/pull/2947)
* [ ] Environment variables (CLICOLOR_FORCE, CONAN_HOME, etc)
* [x] Hooks (Now, it's in `Reference -> Extensions -> Hooks`)
* [x] Methods
* [x] All of them, add them and assign yourself as you write them (https://github.com/conan-io/docs/pull/2953)
* [x] Commands (Added basic `--help` output for every command inhttps://github.com/conan-io/docs/pull/2997 @RubenRBS)
* [x] conan config home (https://github.com/conan-io/docs/pull/2957)
* [ ] conan graph (everything)
* [ ] conan inspect (@davidsanfal )
* [ ] conan lock (@franramirez688 )
* [ ] conan list (HTML format - depends on Conan development WIP) (@davidsanfal )
* [ ] conan profile (@franramirez688 )
* [ ] conan remote (@franramirez688 )
* [ ] conan search (review it!) (@franramirez688 )
* [ ] conan create (@franramirez688 )
* [ ] conan export (@RubenRBS )
* [ ] conan test (@RubenRBS )
* [ ] conan upload (@RubenRBS )
* [x] conan remove (@RubenRBS )
* [ ] conan build (@RubenRBS )
* [ ] Extensions
* [x] Python requires (remember to add a simple intro in `Other important Conan features` - tutorial/other_features.rst)
* [ ] Python API (almost all the sub-sections) <- Dont document them for now
* [x] Binary compatibility (it's there, but should we add a more complex example?)
* [x] Profile plugin (we only have to add the `profile` link to its reference) (https://github.com/conan-io/docs/pull/2971)
* [x] Deployers (https://github.com/conan-io/docs/pull/2946)
* [ ] Add missing intro in `Other important Conan features` section (tutorial/other_features.rst)
* [ ] Recipe Tools
* [x] IntelCC (https://github.com/conan-io/docs/pull/2973)
* [ ] Add example (based on legacy `howtos/intel_compiler.rst` -> [doc](https://docs.conan.io/en/latest/howtos/intel_compiler.html))
* [ ] conan.tools.files.rmdir() (only docstring in Conan)
* [x] conan.tools.files downloads (add link to `global.conf`) (https://github.com/conan-io/docs/pull/2973)
* [x] ~~MesonDeps (docstrings in Conan)~~ (removed in https://github.com/conan-io/conan/pull/13134)
* [ ] MSBuildToolchain (docstrings in Conan)
* [ ] NMakeXXXXX (review all their docstrings)
* [ ] vs_layout (poorly explained)
* [ ] conan.tools.microsoft.visual.unix_path (docstrings in Conan)
* [ ] conan.tools.microsoft.visual.subsytems (totally missing)
* [ ] conan.tools.scm.Version (review docstrings)

Feel free to add/edit missing/wrong parts. Furthermore, feel free to put your own name (for instance "@xxxxxx WIP") for each checkbox if you're working on a new PR for that section to avoid collisions

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.