{"id":39656657,"url":"https://github.com/menandmice/micetro_docs","last_synced_at":"2026-01-18T09:18:36.107Z","repository":{"id":37033933,"uuid":"340325646","full_name":"menandmice/micetro_docs","owner":"menandmice","description":"Documentation for Micetro by BlueCat","archived":false,"fork":false,"pushed_at":"2025-12-11T13:40:51.000Z","size":76685,"stargazers_count":4,"open_issues_count":0,"forks_count":8,"subscribers_count":3,"default_branch":"latest","last_synced_at":"2025-12-12T17:00:12.086Z","etag":null,"topics":["ddi","dhcp-management","dns-management","documentation","ip-address-management","ipam"],"latest_commit_sha":null,"homepage":"https://menandmice.com/products/micetro","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/menandmice.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":"support.rst","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-02-19T09:51:46.000Z","updated_at":"2025-12-11T13:36:58.000Z","dependencies_parsed_at":"2023-09-23T14:19:54.322Z","dependency_job_id":"8f71fcf9-60df-4be7-ab30-3ceae0216862","html_url":"https://github.com/menandmice/micetro_docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/menandmice/micetro_docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/menandmice%2Fmicetro_docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/menandmice%2Fmicetro_docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/menandmice%2Fmicetro_docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/menandmice%2Fmicetro_docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/menandmice","download_url":"https://codeload.github.com/menandmice/micetro_docs/tar.gz/refs/heads/latest","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/menandmice%2Fmicetro_docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28534156,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["ddi","dhcp-management","dns-management","documentation","ip-address-management","ipam"],"created_at":"2026-01-18T09:18:33.744Z","updated_at":"2026-01-18T09:18:36.099Z","avatar_url":"https://github.com/menandmice.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Micetro\r\n\r\nWelcome to the documentation repository for Micetro, a backend-agnostic DDI orchestration software for complex enterprise network environments.\r\n\r\n![micetro](https://user-images.githubusercontent.com/7282347/137749200-e209daf1-f00b-4489-9b0e-419d9928259c.png)\r\n\r\n\r\nDeployed in any on-premises, hybrid, or multicloud network environment, Micetro acts as a non-disruptive overlay that unifies server management under a single GUI and API. Micetro is a modular, software-defined DDI solution built around a number of components, and accessed through a unified user interface and API.\r\n\r\nLearn more on https://menandmice.com\r\n\r\nA free trial is available at https://https://bluecatnetworks.com/products/micetro/#form-micetrotrial\r\n\r\n# How to build the documentation locally\r\nWhen writing documentation it is a good practice to have a local build to verify the setup and overall syntax before making a pull request to change the documentation itself. This section describes how to do a local build.\r\n\r\n## Prerequisites\r\nTo be able to build the `micetro_docs` repository using Sphinx, the following tools needs to be installed:\r\n  * Python 3\r\n  * Git\r\n\r\n## Build\r\nIt is possible to build the documentation in 2 ways, either by using Sphinx directly or with Shpinx autobuild\r\n\r\n### Sphinx\r\nThe following steps are needed for building micetro_docs with Sphinx\r\n * Open a command line window.\r\n * Check out the Git repository at https://github.com/menandmice/micetro_docs.git in some local folder.\r\n * Navigate to the local folder.\r\n * Run `pip install pipenv`.\r\n * Run `pipenv install`, this should install the necessary python libraries as defined in `requirements.txt`.\r\n * Run `pipenv run sphinx-build -M html . build/` which will build the solution and put the output into the `build` folder.\r\n * Navigate to `build\\html` and open index.html in a browser.\r\n * This should open up the documentation.\r\n\r\nThis would be the preferred approach if you only need to build the documentation once, such as in build pipelines for internal deployment and testing.\r\n\r\n### Sphinx autobuild\r\nWhen working locally, it can become cumbersome to manually rebuild the documentation after every change. In this case, it is better to use Sphinx, autobuild as that will monitor a folder on the local filesystem and rebuilds the documentation after each change, the end result is then hosted on a web server running on a local port. To start sphinx-autobuild:\r\n  * Open a command line windows.\r\n  * Checkout the Git repository at https://github.com/menandmice/micetro_docs.git in some local folder.\r\n  * Navigate to the local folder.\r\n  * Run `pip install sphinx-autobuild`.\r\n  * Run `pip install sphinx-rtd-theme`.\r\n  * Run `sphinx-autobuild . build/html`.\r\n\r\nAfter this, Sphinx should be running on http://127.0.0.1:8000 and navigating to this path in a browser should open up the documentation.\r\n\r\nFor more information on Sphinx autobuild, see https://github.com/sphinx-doc/sphinx-autobuild.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmenandmice%2Fmicetro_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmenandmice%2Fmicetro_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmenandmice%2Fmicetro_docs/lists"}