{"id":23091430,"url":"https://github.com/panda3d/panda3d-docs","last_synced_at":"2025-04-05T22:08:09.418Z","repository":{"id":40589224,"uuid":"189281679","full_name":"panda3d/panda3d-docs","owner":"panda3d","description":"Sphinx documentation for Panda3D","archived":false,"fork":false,"pushed_at":"2024-11-08T11:24:39.000Z","size":19571,"stargazers_count":48,"open_issues_count":39,"forks_count":54,"subscribers_count":14,"default_branch":"1.10","last_synced_at":"2025-03-29T21:06:42.552Z","etag":null,"topics":["documentation","panda3d","panda3d-game-engine","sphinx","sphinx-doc"],"latest_commit_sha":null,"homepage":"https://docs.panda3d.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/panda3d.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2019-05-29T18:54:31.000Z","updated_at":"2024-12-23T12:04:35.000Z","dependencies_parsed_at":"2024-01-09T00:30:14.575Z","dependency_job_id":"0d43e28f-aebd-438b-8f70-ff5a2c661cbc","html_url":"https://github.com/panda3d/panda3d-docs","commit_stats":{"total_commits":401,"total_committers":19,"mean_commits":"21.105263157894736","dds":0.1296758104738155,"last_synced_commit":"f645db193247d008e52ff76de6a173c3ec95c9ef"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panda3d%2Fpanda3d-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panda3d%2Fpanda3d-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panda3d%2Fpanda3d-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panda3d%2Fpanda3d-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/panda3d","download_url":"https://codeload.github.com/panda3d/panda3d-docs/tar.gz/refs/heads/1.10","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247406090,"owners_count":20933803,"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":["documentation","panda3d","panda3d-game-engine","sphinx","sphinx-doc"],"created_at":"2024-12-16T21:18:20.799Z","updated_at":"2025-04-05T22:08:09.390Z","avatar_url":"https://github.com/panda3d.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Panda3D Documentation\n\nThis repository contains the source code for the documentation of the\n[Panda3D](https://www.panda3d.org/) game engine.\n\nThe resulting documentation can be found at: https://docs.panda3d.org/\n\n## Building the Documentation\n\nThe documentation is built upon [Sphinx](https://www.sphinx-doc.org/en/master/),\nand several extensions are required.  The easiest way to install Sphinx and the\nextensions into an existing Python installation is using pip:\n```\npip install -r requirements.txt\n```\n\nYou can then build the manual in the desired format.  For example, you can build\nit in the HTML format by executing this command in your command prompt:\n```\nmake html\n```\n\nIf the command was successful, the resulting documentation can be found in the\n`_build/html` folder.  Other formats are also possible, such as `make latexpdf`\nfor producing a .pdf file.  Consult the Sphinx manual for other options.\n\nOn Windows, if you receive an error like the following:\n```\nThe 'sphinx-build' command was not found. Make sure you have Sphinx\ninstalled, then set the SPHINXBUILD environment variable to point\nto the full path of the 'sphinx-build' executable. Alternatively you\nmay add the Sphinx directory to PATH.\n```\n\nIt may be the case that your Python Scripts folder is not on the PATH.  The\neasiest way to deal with this is by setting your SPHINXBUILD variable something\nlike so (adjust for the location of your Python build):\n\n```\nset SPHINXBUILD=C:\\Panda3D-1.10.15-x64\\python\\python.exe -m sphinx\n```\n\n## Editing the Documentation\n\nTo make changes, simply edit the .rst files in a code editor and rerun the\n`make html` command to rebuild only the files that have changed.\n\nTo propose changes, push the changes to a local branch on a fork of the GitHub\nrepository and open a Pull Request.  For more information on how to do this,\nrefer to this guide:\n\nhttps://opensource.guide/how-to-contribute/#opening-a-pull-request\n\n## Coding Style\n\nWhen editing the documentation, please try to conform to the following\nguidelines:\n\n* Running text should be wrapped to an 80-character ruler. Many editors have\n  a feature to do this automatically (eg. Alt+Q in Sublime Text).\n  Code may exceed this, as long as it follows our code guidelines for the\n  respective language, with a strict limit of 86 characters relative to the base\n  indent of the code block (LaTeX starts wrapping code beyond that).\n* Please configure your editor to strip extra spaces at the end of a line.\n* Use a single blank newline at the end of each file.\n* Indentation for ReStructuredText should be 3 spaces, except code blocks,\n  which need to be indented to 4 spaces for Python code and 2 for C++.\n* The manual exists mostly to explain concepts and should not become a cookbook\n  for code examples.  However, in a few cases it is helpful to have a complete\n  code example listed.  In this case, put it in a separate .py file and refer to\n  it using a `.. literalinclude::` block.\n* When choosing a location for a new manual page, keep the filename concise, and\n  try to avoid creating redundancy in the path. For example, prefer\n  `bullet/tutorial.rst` over `the-bullet-integration/bullet-tutorial.rst`.\n* Page titles should be underlined with `===`, sections with `---`, and finally,\n  sub-sections with `^^^`, and the underline should be as wide as the title.\n* You can link to a class in the API reference using ``:class:`.NodePath` `` and\n  to a method with ``:meth:`.NodePath.reparent_to()` `` if you want to include\n  the class prefix, or ``:meth:`~.NodePath.reparent_to()` `` if you just want to\n  show the name of the method, like `reparent_to()`.  You can use custom text as\n  well, like ``:meth:`myNodePath.reparentTo(render) \u003c.NodePath.reparent_to\u003e` ``.\n* When removing a page, please edit the `_static/redirects.json` file to create\n  a redirect to a page that contains similar content.  There is nothing more\n  frustrating to a user than having existing bookmarks, links from other sites,\n  and links from Google turn up 404 pages.  The redirect file is processed by a\n  custom 404 handler on the server, so you need to really delete the page for\n  the redirect to work.  If there is no obvious redirect target (eg. if the page\n  was split up into multiple pages), you can leave a disambiguation page marked\n  with `:orphan:` on the first line.\n* See the [Python guide](https://devguide.python.org/documenting/#style-guide)\n  for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpanda3d%2Fpanda3d-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpanda3d%2Fpanda3d-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpanda3d%2Fpanda3d-docs/lists"}