{"id":18886540,"url":"https://github.com/facultyai/faculty-sphinx-theme","last_synced_at":"2025-04-14T21:31:09.697Z","repository":{"id":45383441,"uuid":"254437642","full_name":"facultyai/faculty-sphinx-theme","owner":"facultyai","description":"A Sphinx theme for Faculty projects","archived":false,"fork":false,"pushed_at":"2023-04-17T13:41:18.000Z","size":33,"stargazers_count":5,"open_issues_count":2,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-03-25T20:20:49.824Z","etag":null,"topics":["python","sphinx"],"latest_commit_sha":null,"homepage":"https://docs.faculty.ai/","language":"CSS","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/facultyai.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-2.0.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-09T17:33:09.000Z","updated_at":"2024-03-25T20:20:49.825Z","dependencies_parsed_at":"2022-09-06T09:21:44.230Z","dependency_job_id":null,"html_url":"https://github.com/facultyai/faculty-sphinx-theme","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facultyai%2Ffaculty-sphinx-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facultyai%2Ffaculty-sphinx-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facultyai%2Ffaculty-sphinx-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facultyai%2Ffaculty-sphinx-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/facultyai","download_url":"https://codeload.github.com/facultyai/faculty-sphinx-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223647330,"owners_count":17179231,"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":["python","sphinx"],"created_at":"2024-11-08T07:28:18.014Z","updated_at":"2024-11-08T07:28:18.560Z","avatar_url":"https://github.com/facultyai.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"faculty-sphinx-theme\n====================\n\n``faculty-sphinx-theme`` is a `Sphinx \u003chttps://www.sphinx-doc.org/\u003e`_ theme for\n`Faculty \u003chttps://faculty.ai/\u003e`_ projects. It's based on `the Read the Docs\ntheme \u003chttps://sphinx-rtd-theme.readthedocs.io/\u003e`_, but with Faculty branding\nand an optional navigation bar for use in the `Faculty platform docs\n\u003chttps://docs.faculty.ai\u003e`_.\n\nInstallation\n------------\n\n.. code-block:: bash\n\n    pip install faculty-sphinx-theme\n\nUsage\n-----\n\nInstall ``faculty-sphinx-theme`` and configure your Sphinx project to use the\ntheme. In your project's ``conf.py``, add ``faculty_sphinx_theme`` to the list\nof enabled extensions:\n\n.. code-block:: python\n\n    extensions = [\n        \"faculty_sphinx_theme\",\n        # Plus any other extensions you are using\n    ]\n\nand modify the ``html_theme`` setting to:\n\n.. code-block:: python\n\n    html_theme = \"faculty-sphinx-theme\"\n\nTheme options\n+++++++++++++\n\nThe theme provides an optional extra navbar with custom links. To enable it,\nuse the ``faculty_navbar`` settings. You'll probably also want to set the\n``faculty_navbar_root`` setting which defines the link on the \"Faculty logo\":\n\n.. code-block:: python\n\n    html_theme_options = {\n        \"faculty_navbar\": True,\n        \"faculty_navbar_root\": \"https://docs.faculty.ai/\",\n    }\n\nTo add entries to the navbar, add sections to the ``faculty_navbar_content``\nsetting:\n\n.. code-block:: python\n\n    html_theme_options = {\n        \"faculty_navbar\": True,\n        \"faculty_navbar_root\": \"https://docs.faculty.ai/\",\n        \"faculty_navbar_content\": [\n            {\"title\": \"Section 1\", \"url\": \"https://sectionone.com/\"},\n            {\"title\": \"Section 2\", \"url\": \"https://sectiontwo.com/\"},\n        ]\n    }\n\nYou can also add menu items that appear on hover below the section headings.\nTo add these, use the ``entries`` key on a section:\n\n.. code-block:: python\n\n    html_theme_options = {\n        \"faculty_navbar\": True,\n        \"faculty_navbar_root\": \"https://docs.faculty.ai/\",\n        \"faculty_navbar_content\": [\n            {\n                \"title\": \"Section 1\",\n                \"url\": \"https://sectionone.com/\",\n                \"entries\": [\n                    {\n                        \"title\": \"Section 1.1\",\n                        \"url\": \"https://sectionone.com/one\",\n                    },\n                    {\n                        \"title\": \"Section 1.2\",\n                        \"url\": \"https://sectionone.com/one\",\n                    },\n                ]\n            },\n            {\"title\": \"Section 2\", \"url\": \"https://sectiontwo.com/\"},\n        ]\n    }\n\nIt's also possible to mark sections and entries as ``external``, meaning they\nwill open in a separate tab, or to omit the URL entirely for e.g. section\nheadings:\n\n.. code-block:: python\n\n    html_theme_options = {\n        \"faculty_navbar\": True,\n        \"faculty_navbar_root\": \"https://docs.faculty.ai/\",\n        \"faculty_navbar_content\": [\n            {\n                \"title\": \"No URL\",\n                \"entries\": [\n                    {\n                        \"title\": \"External link\",\n                        \"url\": \"https://external.com/\",\n                        \"external\": True\n                    },\n                ]\n            },\n            {\"title\": \"Section 2\", \"url\": \"https://sectiontwo.com/\"},\n        ]\n    }\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffacultyai%2Ffaculty-sphinx-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffacultyai%2Ffaculty-sphinx-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffacultyai%2Ffaculty-sphinx-theme/lists"}