{"id":15136799,"url":"https://github.com/conan-io/docs","last_synced_at":"2025-05-15T11:05:49.780Z","repository":{"id":37493109,"uuid":"47185737","full_name":"conan-io/docs","owner":"conan-io","description":"conan.io reStructuredText documentation","archived":false,"fork":false,"pushed_at":"2025-04-29T12:54:43.000Z","size":299577,"stargazers_count":113,"open_issues_count":371,"forks_count":370,"subscribers_count":18,"default_branch":"develop2","last_synced_at":"2025-05-13T09:07:47.588Z","etag":null,"topics":["conan","conan-documentation","documentation","restructuredtext"],"latest_commit_sha":null,"homepage":"http://docs.conan.io","language":"NASL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/conan-io.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-12-01T11:42:37.000Z","updated_at":"2025-04-29T21:41:41.000Z","dependencies_parsed_at":"2023-11-24T10:47:17.995Z","dependency_job_id":"9178d284-1e87-4f2b-bd03-bd03efc9b843","html_url":"https://github.com/conan-io/docs","commit_stats":{"total_commits":3228,"total_committers":274,"mean_commits":"11.781021897810218","dds":0.7825278810408922,"last_synced_commit":"47a9e2f12df630805e294096aefafd0cde38491f"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conan-io%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conan-io%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conan-io%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conan-io%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/conan-io","download_url":"https://codeload.github.com/conan-io/docs/tar.gz/refs/heads/develop2","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254328385,"owners_count":22052632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conan","conan-documentation","documentation","restructuredtext"],"created_at":"2024-09-26T06:41:23.791Z","updated_at":"2025-05-15T11:05:49.774Z","avatar_url":"https://github.com/conan-io.png","language":"NASL","funding_links":[],"categories":[],"sub_categories":[],"readme":"Documentation for Conan C/C++ package manager: https://conan.io\n\nHow to build\n============\n\n- Install prerequisites:\n  - [graphviz](https://graphviz.org/download)\n  - [enchant](https://pyenchant.github.io/pyenchant/install.html)\n\n- Install python and [pip docs](https://pip.pypa.io/en/stable/installing/).\n- Install the requirements (sphinx):\n\n  `$ pip install -r requirements.txt`\n\n- Point to the Conan source code folder (``git clone https://github.com/conan-io/conan \u0026\u0026 cd conan \u0026\u0026 git checkout develop2``)\n\n  - Windows:\n  `$ set PYTHONPATH=\u003cyour/path/to/conan\u003e;%PYTHONPATH%`\n  - Linux:\n  `$ export PYTHONPATH=\u003cyour/path/to/conan\u003e:$PYTHONPATH`\n\n\n- Build the documentation:\n\n  `$ make html`\n\nHow to read the built docs\n==========================\n\nOpen a browser and select the *_build/html/index.html* file.\n\nExample:\n\n`$ firefox _build/html/index.html`\n\nHow to contribute\n=================\n\nTo make any contribution to Conan documentation fork this repository and open a Pull Request.\n\nStyle Guidelines\n----------------\n\nThis guidelines are just general good practices for the formatting and structure of the whole documentation and do not pretend to be a\nstopper for any helpful contribution. Any contribution that may include relevant information for Conan users will always be welcomed.\n\nConan documentation is written in [reStructuredText](http://docutils.sourceforge.net/rst.html) and\nfollows [reStructuredText Markup Specification](http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html).\n\n[Quick reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickref.html) is also used for reference.\n\nAny detail not covered by this guidelines will follow the aforementioned rules.\n\n### Section titles\n\nUse section titles in this level of importance:\n\n```\nSection Title\n=============\n\nSection Title\n-------------\n\nSection Title\n+++++++++++++\n\nSection Title\n^^^^^^^^^^^^^\n```\n\n### Text emphasis/highlighting\n\n- **Bold text** to highlight important text:\n\n  ```\n  Note the simple scenario of a **header-only** library. Such package...\n  ```\n\n- *Italics* to refer to file names, directory names and paths.\n\n  ```\n  If you have a look to the *test_package* folder, you will realize that the *example.cpp* and the *CMakeLists.txt* files don't have\n  anything special. The *test_package/conanfile.py* file is...\n  ```\n\n- ``Command inline literals`` to refer to command line, both full commands and command line arguments, or any extract of a full command.\n  ```\n  To create a conan package you can use :command:`conan create`.  You can see a :command:`git clone` command... You may call it with the :command:`--keep-source` option to avoid deleting and fetching the source.\n  ```\n\n- ``Inline literals`` to refer to code or text inside recipes:\n\n  ```\n   ``package()`` -\u003e conanfile.py method\n   ``cmake`` -\u003e generator in conanfile.txt\n   ``settings`` -\u003e variable inside a ConanFile class in conanfile.py\n   ```\n\n  Like this:\n\n  ```\n  Note that the ``build_id()`` method uses the ``self.info_build`` object to alter the build hash.\n  ```\n\n- Other names like CMake, Autotools, Conan, Visual Studio should not be emphasized, just use a capital letter or follow the convention (like\n  first and second capitalized letters for CMake).\n\n### code-blocks\n\nUse code-blocks for code snippets or command line actions and follow the specific language\nindentation. Documentation makes an extensive use of bash, python, txt and cmake code-blocks.\n\n```\n.. code-block:: python\n\n    from conan import ConanFile\n\n    class EigenConan(ConanFile)\n        name = \"eigen\"\n        version = \"3.3.4\"\n\n        def source():\n            tools.get(\"https://some_url.org\")\n            ...\n```\n\n```\n.. code-block:: text\n\n    [requires]\n    poco/1.9.4\n    zlib/1.2.11\n```\n\n```\n.. code-block:: bash\n   :emphasize-lines: 3\n\n    $ conan source . --source-folder src\n    $ conan install --install-folder build_x86 -s arch=x86\n    $ conan build . --build-folder build_x86 --source-folder src\n    $ conan export-pkg . Hello/0.1@user/stable --build-folder build_x86\n```\n\n### Indentation and line length\n\nMake sure all indentation is done with spaces. Normally 2 space indentation for bulleted lists and 4 space indentation for code blocks. In some\ncases a 3 space indentation is needed for reStructuredText specifics like toc-trees:\n\n```\n.. toctree::\n   :maxdepth: 2\n\n   creating_packages/getting_started\n   creating_packages/package_repo\n```\n\nThe **maximum line length for documentation is 140 characters** except for lines inside code-blocks, external links or references.\n\nDo not leave any unnecessary or trailing spaces.\n\n### Text boxes\n\nAlso called **Admonitions**, they are eye-catching texts with a clear purpose like warnings, tips or important content.\n\nUse them in the following importance order:\n\n1. caution\n2. attention\n3. warning\n4. important\n5. note\n6. tip\n\n```\n.. warning::\n\n    In the ConanCenter repository there are binaries for several mainstream compilers...\n```\n\n```\n.. tip::\n\n    Using profiles is strongly recommended. Learn more about them...\n```\n\n### References\n\nReferences are commonly used in the documentation and it's always a good way to highlight texts and give an implicit or explicit importance\nto something.\n\n#### Internal reference\n\nUse an internal reference when you want to refer to a specific section in this documentation. Most of the sections have a reference mark\njust before their names so you can reference it.\n\n```\n.. _conan_export_pkg_command:\n\nconan export-pkg\n================\n\n...\n```\n\nTo add a reference to the `conan export-pkg` command from another text:\n\n```\nRead more about the :ref:`conan export-pkg\u003cconan_export_pkg_command\u003e` command.\nOr reference the :ref:`conan_export_pkg_command` directly.\n```\n\n#### External references\n\nUse external references with external URL at the bottom of the file like this:\n\n```\nSubmit a pull request to include it in `conan-center-index`_.\n...\n...\n\n.. _`conan-center`: https://center2.conan.io\n```\n\nIn case you want to use explicit external references with a link, make sure it doesn't exceed the maximum line length, otherwise it\nshould considered to be written as a normal external reference.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconan-io%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconan-io%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconan-io%2Fdocs/lists"}