{"id":39172282,"url":"https://github.com/aimms/sphinx-aimms-theme","last_synced_at":"2026-01-20T17:28:10.510Z","repository":{"id":62559739,"uuid":"428285086","full_name":"aimms/sphinx-aimms-theme","owner":"aimms","description":"This Sphinx theme was designed to provide a great reader experience for documentation users on both desktop and mobile devices for AIMMS projects and libraries.","archived":false,"fork":false,"pushed_at":"2025-10-17T08:06:04.000Z","size":649,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-12-02T07:58:46.937Z","etag":null,"topics":["aimms","documentation","python","sphinx"],"latest_commit_sha":null,"homepage":"","language":"Python","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/aimms.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2021-11-15T13:56:37.000Z","updated_at":"2025-10-17T08:06:08.000Z","dependencies_parsed_at":"2025-12-14T02:12:31.509Z","dependency_job_id":null,"html_url":"https://github.com/aimms/sphinx-aimms-theme","commit_stats":{"total_commits":132,"total_committers":3,"mean_commits":44.0,"dds":0.06060606060606055,"last_synced_commit":"650b69771ca8d07ad578120c5195d2c27bf37ac7"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aimms/sphinx-aimms-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aimms%2Fsphinx-aimms-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aimms%2Fsphinx-aimms-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aimms%2Fsphinx-aimms-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aimms%2Fsphinx-aimms-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aimms","download_url":"https://codeload.github.com/aimms/sphinx-aimms-theme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aimms%2Fsphinx-aimms-theme/sbom","scorecard":{"id":173114,"data":{"date":"2025-08-11","repo":{"name":"github.com/aimms/sphinx-aimms-theme","commit":"9d8a866c184f46c92ddf8f6d4f17ae7b5d2ad0e8"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-16T17:05:18.279Z","repository_id":62559739,"created_at":"2025-08-16T17:05:18.279Z","updated_at":"2025-08-16T17:05:18.279Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28520306,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T22:11:28.393Z","status":"ssl_error","status_checked_at":"2026-01-17T22:11:27.841Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["aimms","documentation","python","sphinx"],"created_at":"2026-01-17T22:24:20.213Z","updated_at":"2026-01-17T22:24:20.771Z","avatar_url":"https://github.com/aimms.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sphinx-aimms-theme \n \nThis [Sphinx](https://www.sphinx-doc.org/en/master/) theme was designed to provide a great reader experience for documentation users on both desktop and mobile devices for AIMMS projects and libraries.\n\n**This theme also includes:** \n- an **[AIMMS pygment lexer](docs/AIMMS Lexer.md)** to highlight your AIMMS [code blocks in sphinx](http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block) \n- an **[AIMMS Domain](docs/AIMMS Domain.md)** to document your own AIMMS code, and to [**crosslink** with other AIMMS documentation websites ](docs/AIMMS%20Domain.md#coupling-the-domain-with-intersphinx)\n- an **[AIMMS spelling wordlist](docs/AIMMS spelling wordlist.md)** to use as a spelling wordlist exception file for the [sphinx spelling checker extension](https://sphinxcontrib-spelling.readthedocs.io/en/latest/)\n\nPlease find the documentation of those elements following the links above.\n\nThis theme is inherited from the great [Read the Docs](https://github.com/readthedocs/sphinx_rtd_theme) but can work with any Sphinx project. \n\nYou can find a working demo of the theme on AIMMS documentation websites:\n- [AIMMS Function reference](https://documentation.aimms.com/functionreference)\n- [AIMMS How-to](https://how-to.aimms.com)\n- [AIMMS Documentation](https://documentation.aimms.com)\n\n**To generate your docs out of this theme** from an AIMMS model, please take a look at the following repo: https://gitlab.com/ArthurdHerbemont/conversion-aimms-ams2rst\n\nInstallation\n===============\n\nThis theme is distributed on [PyPI](https://pypi.org/project/sphinx-aimms-theme/) and can be installed with pip. \n\nBecause it's inheriting some features from [Read the Docs theme](https://github.com/readthedocs/sphinx_rtd_theme), you will need to install it as well. \nYou may run the following 2 commands to install it:\n\n`pip install sphinx-rtd-theme`\n\n`pip install sphinx-aimms-theme`\n\nTo use the theme in your Sphinx project, you will need to add the following to your conf.py file:\n\n``` python\nextensions = [\n    ...\n    \"sphinx_aimms_theme\",\n]\n\nhtml_theme = \"sphinx_aimms_theme\"\n```\n\n\nConfiguration\n================\n\nTheme options\n----------------\n\nThe following options can be defined in your project’s conf.py file, using the html_theme_options configuration option.\n\nFor example:\n\n``` python\nhtml_theme_options = {\n    'doc_title': 'Title of my docs',\n    'home_page_description': 'my meta description',\n}\n```\n\n*(if not specified, the option is a string)*\n\n* **doc_title** \n\n    Title you will see on the top left corner of your docs\n\n* **home_page_title** \n\n    HTML Title that will appear in the html meta title of your home page \n\n* **home_page_description** \n\n    Description that will appear in the html meta description of your home page\n    \n* **display_community_help_link** \n\n    Boolean - Displays a link at the bottom of every article redirecting to the [AIMMS community](https://community.aimms.com/) search page filled with the title of the current page.\n    \n* **display_community_embeddable** \n\n    Boolean - Displays an embbedable from the AIMMS Community, showing topics filtered with the title of the current page \n    \n    \u003e Send an email to support@aimms.com if you would like to activate the community embeddable on your docs.\n\n* **display_local_toc** \n\n    Boolean - Displays a dynamic local table of content for each file, except top index files.\n\n* **generate_google_analytics**\n    \n    Boolean - generates a google analytics HTML code as follows on every page:\n    \n    ``` html\n        \n        \u003cscript async src=\"https://www.googletagmanager.com/gtag/js?id={{ google_analytics_id }}\"\u003e\u003c/script\u003e\n        \u003cscript\u003e\n            window.dataLayer = window.dataLayer || [];\n        \n            function gtag() {\n                dataLayer.push(arguments);\n            }\n            gtag('js', new Date());\n        \n            gtag('config', '{{ google_analytics_id }}');\n        \u003c/script\u003e\n        \n    ```\n    Where ``google_analytics_id`` is the following option\n\n* **google_analytics_id**\n\n    Change the Google Analytics ID that is included on every page\n\n* **generate_google_tag_manager**\n    \n    Boolean - generates the google tag manager container snippet on every page, based on the following ``google_tag_manager_id``\n\n* **google_tag_manager_id**\n\n    Change the google tag manager ID that is included on every page\n\n* **display_algolia_search**\n    \n    Replace the current default search box with an Algolia extension. \n    You must have registered your docs website on https://community.algolia.com/docsearch/#join-docsearch-program, and thus obtain from Algolia the following 3 options:\n\n* **algolia_appid**\n* **algolia_appkey**\n* **algolia_indexname**\n\n* **algolia_hitsperpage**\n\n    Set the number of items shown in algolia's search result dropdown\n\n* **display_help_and_feedback**\n\n    Boolean - Displays a \"Help \u0026 feedback\" footer block at the end of every page content. This Block is linking to many useful resources for AIMMS users, and crosslinks to the open source repository.\n    Default - False\n    \n* **is_github**\n\n    Boolean - Is your code hosted on Github ? \n    Default - False\n    \n* **is_gitlab**\n\n    Boolean - Is your code hosted on Gitlab ? \n    Default - False\n    \n* **repo_url**\n\n    String - The URL link to your open source repository hosting your documentation docs. This is used to build crosslinks on a page to its open source conterpart, to ease potential peer contribution.\n    Default is \"https://gitlab.com/ArthurdHerbemont/testdocs\"\n\n\nTheme source code\n-------------------\n\nThe theme source code can be found in your Python installation folder, at ``PythonXX\\Lib\\site-packages\\sphinx_aimms_theme``.\n\nYou may customize (overwrite) locally parts of it via \"templating\", as described [here](https://www.sphinx-doc.org/en/master/templating.html)\n\nHome Page\n----------\n\nSome CSS code is shipped together with the theme to customize your home page \"boxes\", as you can see on [AIMMS How-to](https://how-to.aimms.com) or [AIMMS Documentation](https://documentation.aimms.com).\n\nYou may (or not) use it to show your own topics. To help you customize it, please see the [RST](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) source code of the How-to Home page below:\n\n``` html\n\n.. image:: Images/rocket-32.png\n   :scale: 0\n\n.. image:: Images/school-supplies-32.png\n   :scale: 0\n\n.. image:: Images/time-machine-32.png\n   :scale: 0\n\n.. image:: Images/global-chain-32.png\n   :scale: 0\n\n.. image:: Images/web-design-32.png\n   :scale: 0\n\n.. image:: Images/network-care-32.png\n   :scale: 0\n\n.. raw:: html\n    \n    \u003ch1 class=\"home_header\"\u003eWELCOME TO HOW-TO\u003c/h1\u003e\n    \n.. raw:: html\n    \n    \u003cdiv id=\"content_home_page\"\u003e\n\n        \u003cp\u003eAIMMS How-To is a knowledge base for everyone involved in projects that use AIMMS, including developers, network administrators, application end-users, and business process stakeholders.\u003c/p\u003e\n        \u003cp\u003eYou'll find tutorials, best practices, and practical guidance for using AIMMS software, including help topics in mathematical modeling, solvers, AIMMS language, and building applications in optimization and prescriptive analytics. You'll also find support for troubleshooting errors and handling deprecations.\u003c/p\u003e\n\n        \u003cdiv class=\"boxes\"\u003e\n            \u003ca class=\"box_home_page\" href=\"C_Getting_Started/index.html\"\u003e\n                \u003cimg alt=\"getting started\" src=\"_images/rocket-32.png\"\u003e\n                \u003ch1\u003eGetting Started\u003c/h1\u003e\n                \u003cdiv\u003eInstalling AIMMS, settings options, licensing help\u003c/div\u003e\n            \u003c/a\u003e\n            \u003ca class=\"box_home_page\" href=\"C_Developer/index.html\"\u003e\n                \u003cimg alt=\"developer\" src=\"_images/school-supplies-32.png\"\u003e\n                \u003ch1\u003eAIMMS Developer\u003c/h1\u003e\n                \u003cdiv\u003eData connection, modeling, solvers, programming, error handling\u003c/div\u003e\n            \u003c/a\u003e\n            \u003ca class=\"box_home_page\" href=\"C_UI/index.html\"\u003e\n                \u003cimg alt=\"applications\" src=\"_images/web-design-32.png\"\u003e\n                \u003ch1\u003eApplication UI\u003c/h1\u003e\n                \u003cdiv\u003eCreating and customizing a user interface for your apps\u003c/div\u003e\n            \u003c/a\u003e\n            \u003ca class=\"box_home_page\" href=\"C_Deployment/index.html\"\u003e\n                \u003cimg alt=\"deployment\" src=\"_images/network-care-32.png\"\u003e\n                \u003ch1\u003eDeployment\u003c/h1\u003e\n                \u003cdiv\u003eDistributing your apps with AIMMS PRO (on-premise or cloud-hosted)\u003c/div\u003e\n            \u003c/a\u003e\n            \u003ca class=\"box_home_page\" href=\"C_Evolution/index.html\"\u003e\n                \u003cimg alt=\"evolution\" src=\"_images/time-machine-32.png\"\u003e\n                \u003ch1\u003eSoftware Evolution\u003c/h1\u003e\n                \u003cdiv\u003eImplementing new AIMMS features, planning for deprecation\u003c/div\u003e\n            \u003c/a\u003e\n            \u003ca class=\"box_home_page\" href=\"https://scnavigator-manual.aimms.com/\"\u003e\n                \u003cimg alt=\"navigator\" src=\"_images/global-chain-32.png\"\u003e\n                \u003ch1\u003eSC Navigator\u003c/h1\u003e\n                \u003cdiv\u003eHelp and documentation for the SC Navigator suite of apps\u003c/div\u003e\n            \u003c/a\u003e\n        \u003c/div\u003e\n    \u003c/div\u003e\n    \n-----------------------------------------------------------\n\n.. toctree::\n   :maxdepth: 1\n   :titlesonly:\n   :hidden:\n\n   C_Getting_Started/index\n   C_Developer/index\n   C_UI/index\n   C_Deployment/index\n   C_Evolution/index\n   Recently_added\n   \n\n```\n    \nUse, contribute, fix, improve the theme\n===================================\n\nRun the theme locally\n----------------------\n\nIf you would like to modify the theme, or correct something, you may use the theme locally on your computer.\n\nThere are at least 2 ways to do that. \n\n1. Copy paste [the theme folder](sphinx_aimms_theme) in your sphinx project folder, and configure the [html_theme_path](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme_path) in your [conf.py](https://www.sphinx-doc.org/en/master/usage/configuration.html) file to point to that theme folder as follows:\n   ``` python\n   html_theme_path=['sphinx_aimms_theme']\n   ```\n\n2. Otherwise, you may want to change your python local package setup temporarily. To do so, download the theme repo on your computer, and run in the repo location:\n\n`python setup.py develop`\n\n\u003e First, you may want to uninstall the theme installed, by running `python -m pip uninstall sphinx-aimms-theme`\n\nContribution and support\n------------------------------\n\nIf you would like to propose a change, or if something's not clear, just send an e-mail to support@aimms.com\n\nNote\n---------\n\n**All readthedocs options are available as well !**\n\nhttps://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html\n\nThis theme is highly customizable on both the page level and on a global level. See https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html \n\nIf you are reviewing the wordlist, this site is helpful to order and remove duplicates: https://sortmylist.com/\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faimms%2Fsphinx-aimms-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faimms%2Fsphinx-aimms-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faimms%2Fsphinx-aimms-theme/lists"}