{"id":25495945,"url":"https://github.com/opennetworkinglab/aether-docs","last_synced_at":"2025-10-30T14:49:47.401Z","repository":{"id":221200195,"uuid":"745220751","full_name":"opennetworkinglab/aether-docs","owner":"opennetworkinglab","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-06T20:37:50.000Z","size":16070,"stargazers_count":4,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T03:13:23.468Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/opennetworkinglab.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSES/Apache-2.0.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-18T21:52:37.000Z","updated_at":"2025-03-06T20:37:54.000Z","dependencies_parsed_at":"2024-06-18T20:55:52.195Z","dependency_job_id":"12b581a2-0128-45cd-aaa8-1f360c136631","html_url":"https://github.com/opennetworkinglab/aether-docs","commit_stats":null,"previous_names":["opennetworkinglab/aether-docs"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opennetworkinglab%2Faether-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opennetworkinglab%2Faether-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opennetworkinglab%2Faether-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opennetworkinglab%2Faether-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opennetworkinglab","download_url":"https://codeload.github.com/opennetworkinglab/aether-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248148242,"owners_count":21055548,"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":[],"created_at":"2025-02-19T00:52:46.794Z","updated_at":"2025-10-30T14:49:42.354Z","avatar_url":"https://github.com/opennetworkinglab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. SPDX-FileCopyrightText: 2021 Open Networking Foundation \u003cinfo@opennetworking.org\u003e\n   SPDX-License-Identifier: Apache-2.0\n\n.. |pub-badge| image:: https://github.com/opennetworkinglab/aether-docs/actions/workflows/publish-docs.yml/badge.svg\n\n|pub-badge|\n\nAether Docs\n===========\n\nThis repo contains Sphinx-formated documentation for the Aether project.\n\nWriting Documentation\n---------------------\n\nDocs are generated using `Sphinx \u003chttps://www.sphinx-doc.org/en/master/usage/\u003e`_ with\n`reStructuredText \u003chttps://www.sphinx-doc.org/en/master/usage/restructuredtext/\u003e`_ syntax.\nA cheat sheet for reStructuredText can be found `here \u003chttps://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst\u003e`_.\n\nBuilding Documentation\n--------------------------\n\nThe documentation build process is stored in a ``Makefile``. Building\ndocs requires Python to be installed, and most steps create a\nvirtualenv (usually ``venv-docs``) which contains the required tools.\nYou may also need to install the ``enchant`` C library using your\nsystem's package manager for the spelling checker to function\nproperly.\n\nRun ``make html`` to generate html documentation in ``_build/html``.\n\nThere is also a test target, ``make test``, which will run all the following\nchecks. This is what happens to validate a patchset.\n\n* ``make lint``: Check the formatting of documentation using `doc8\n  \u003chttps://github.com/PyCQA/doc8\u003e`_.\n\n* ``make spelling``: Checks spelling on all documentation. If there are\n  additional words that are correctly spelled but not in the dictionary\n  (acronyms, nouns, etc.) please add them to the ``dict.txt`` file, which\n  should be alphabetized using ``sort``\n\n* ``make linkcheck``: Verifies that links in the document are working and\n  accessible, using Sphinx's built in linkcheck tool. If there are links that\n  don't work with this, please see the ``linkcheck_ignore`` section of\n  ``conf.py``.\n\nVersioning Documentation\n----------------------------------\n\nTo change the version shown on the build site, change the contents of the\n``VERSION`` file to be released SemVer version. This will create a tag on the\nrepo.\n\nThe ``make multiversion`` target can then be used to build all\nversions tagged or branched on the remote to ``_build/multiversion``. This\nuses a fork of `sphinx-multiversion\n\u003chttps://github.com/Holzhaus/sphinx-multiversion\u003e`_ to build multiple versions\nand a menu on the site.\n\nThere are variables in ``conf.py`` to determine which tags/branches to build.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopennetworkinglab%2Faether-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopennetworkinglab%2Faether-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopennetworkinglab%2Faether-docs/lists"}