{"id":14108887,"url":"https://github.com/clearlinux/clear-linux-documentation","last_synced_at":"2025-05-16T09:06:41.871Z","repository":{"id":21491961,"uuid":"85125899","full_name":"clearlinux/clear-linux-documentation","owner":"clearlinux","description":"This repository contains the documentation source files for Clear Linux OS.","archived":false,"fork":false,"pushed_at":"2024-11-13T23:34:47.000Z","size":117702,"stargazers_count":136,"open_issues_count":30,"forks_count":128,"subscribers_count":30,"default_branch":"master","last_synced_at":"2025-04-09T04:04:51.160Z","etag":null,"topics":["clear-linux","documentation","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://www.clearlinux.org/clear-linux-documentation/reference/index.html","language":"JavaScript","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/clearlinux.png","metadata":{"files":{"readme":"README.rst","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":"2017-03-15T22:13:08.000Z","updated_at":"2025-03-27T06:49:12.000Z","dependencies_parsed_at":"2022-08-29T15:12:08.782Z","dependency_job_id":"fe33834f-84ac-4e84-9750-6b2a74a196fc","html_url":"https://github.com/clearlinux/clear-linux-documentation","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearlinux%2Fclear-linux-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearlinux%2Fclear-linux-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearlinux%2Fclear-linux-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearlinux%2Fclear-linux-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clearlinux","download_url":"https://codeload.github.com/clearlinux/clear-linux-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254501558,"owners_count":22081528,"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":["clear-linux","documentation","hacktoberfest"],"created_at":"2024-08-14T10:01:53.376Z","updated_at":"2025-05-16T09:06:36.856Z","avatar_url":"https://github.com/clearlinux.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"Documentation build instructions\n################################\n\n.. todo add comment re not using standards here.\n\n`Clear Linux\\* OS documentation`_ is written using `reStructuredText`_ and\nbuilt using `Sphinx`_. Follow the instructions in this README to build the\ndocumentation locally for development and testing.\n\nPlease make yourself familiar with our `contribution guidelines`_ before\nsubmitting a contribution.\n\nClone the documentation repository\n**********************************\n\nClone the documentation repository to your local machine.\n\n.. code-block:: bash\n\n   git clone https://github.com/clearlinux/clear-linux-documentation\n\nRequirements\n************\n\nMake sure you have Python 3 installed to start.\n\nThe Sphinx documentation provides `instructions for installing Sphinx`_\non various platforms.\n\nUse pip3 to install additional Python dependencies listed in the\nrequirements.txt file found in the repository:\n\n.. code-block:: bash\n\n   pip3 install -r requirements.txt\n\nRun the build\n*************\n\nWe build our documentation using Sphinx. In the source directory of your\nlocal clear-linux-documentation repository, preview changes to the\ndocumentation by building the docs in the default language (English) by\nrunning ``make html``:\n\n.. code-block:: bash\n\n   make html\n\n.. code-block:: console\n\n   sphinx-build -b html -d _build/doctrees   . _build/html\n   Running Sphinx v1.8.0\n   making output directory...\n   .\n   .\n   .\n   build succeeded, 0 warnings.\n\n   The HTML pages are in _build/html.\n\n   Build finished. The HTML pages are in _build/html.\n\nOpen one of the HTML pages found in ``source/_build/html`` in a web browser\nto view the rendered documentation.\n\nThis build will generate several warnings as there are two other optional make commands required to build the full documentation.\n\n1. ``make py`` to generate the bundle reference material.\n2. ``make man`` to generate man page reference material.\n\nTo build the documentation exactly as seen on the website, use\n``make man``, ``make py``, and ``make htmlall``. This builds both\nexternal dependencies and all supported languages.\n\nUse virtualenv \n**************\n\nTo develop documentation in a ``virtualenv``, use the ``venv`` target.\nThe Clear Linux OS documentation make target ``venv`` provides a \nsimple development environment that ensures that you have the \nlatest packages and that you manage Python versions separately. Use of the \n``virtualenv`` requires **Python 3.6** or higher. For Windows examples below, use Powershell as an Administrator.\n\nThe **virtual environment** uses the same version of Python that was used to **create the virtual environment**. \n\nVerify ``pip`` is installed. A file path to pip should appear. \n\nOn Clear Linux OS and macOS\\*:\n\n.. code-block:: bash\n\n   which pip\n   \nOn Windows\\* 10 OS: \n\n.. code-block:: bash\n\n   pip --version\n\nIf ``pip`` is not installed, install it. \n\nOn Clear Linux OS and macOS:\n\n.. code-block:: bash\n\n   python3 -m pip install --user --upgrade pip\n\nOn Windows 10 OS: \n\n.. code-block:: bash\n\n   py -m pip install --upgrade pip\n\n.. note::\n\n   This assumes Python was already added to your Windows path. \n\nInstall virtualenv \n==================\n\nInstall ``virtualenv``. \n\nOn Clear Linux OS and macOS\\*:\n\n.. code-block:: bash\n\n   python3 -m pip install --user virtualenv\n\nOn Windows 10 OS: \n\n.. code-block:: bash\n\n   py -m pip install --user virtualenv\n\nCreate the ``virtualenv`` and install the required packages: \n\n.. code-block:: bash\n\n   make venv\n\nActivate the ``venv``. \n\n.. code-block:: bash\n\n   source venv/bin/activate\n\nFollow `Run the build`_ section to start developing documentation.\n\nRemove the ``venv`` when finished developing.  \n\n.. code-block:: bash\n\n   deactivate\n\nAdditional help\n***************\n\nCleaning up\n===========\n\nWhen testing changes in the documentation, make sure to remove the previous\nbuild before building again by running ``make clean``:\n\n.. code-block:: bash\n\n   make clean\n\nThis will completely remove the previous build output, including artifacts \nfrom the `make venv` target when done outside an active venv.\n\nBefore running ``make man``, please run ``make clean-man`` to clear out any\nprevious attempts.\n\nConvenience script\n==================\n\nThis bash script (Linux only) includes both ``make clean`` and\n``make html``. It also starts a simple Python web server that\ndisplays a preview of the site at http://localhost:8000 on your local machine.\n\n.. code-block:: bash\n\n   ./checkwork.sh\n\nTo stop the web server simply use ``ctrl-c``.\n\n.. _Clear Linux\\* OS documentation:  https://docs.01.org/clearlinux/\n.. _Sphinx: http://sphinx-doc.org/\n.. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html\n.. _contribution guidelines: https://docs.01.org/clearlinux/latest/collaboration/collaboration.html\n.. _instructions for installing Sphinx: https://www.sphinx-doc.org/en/master/usage/installation.html\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclearlinux%2Fclear-linux-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclearlinux%2Fclear-linux-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclearlinux%2Fclear-linux-documentation/lists"}