Skip to content

Point documentation at docs.networktocode.com and fix site defects #434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jvanderaa wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Point documentation at docs.networktocode.com and fix site defects #434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a69f97a
Point documentation at docs.networktocode.com and fix site defects
jvanderaa Aug 18, 2026
7248f11
Leave the code reference generator unchanged
jvanderaa Sep 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ venv.bak/

# mkdocs documentation
/site
/circuit-maintenance-parser/static/

# mypy
.mypy_cache/
Expand Down
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p align="center">
<a href="https://github.com/networktocode/circuit-maintenance-parser/actions"><img src="https://github.com/networktocode/circuit-maintenance-parser/actions/workflows/ci.yml/badge.svg?branch=main"></a>
<a href="https://circuit-maintenance-parser.readthedocs.io/en/latest/"><img src="https://readthedocs.org/projects/circuit-maintenance-parser/badge/"></a>
<a href="https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/"><img src="https://app.readthedocs.com/projects/circuit-maintenance-parser/badge/"></a>
<a href="https://pypi.org/project/circuit-maintenance-parser/"><img src="https://img.shields.io/pypi/v/circuit-maintenance-parser"></a>
<a href="https://pypi.org/project/circuit-maintenance-parser/"><img src="https://img.shields.io/pypi/dm/circuit-maintenance-parser"></a>
</p>
Expand All @@ -11,13 +11,13 @@

## Documentation

Full documentation for this library can be found over on the [Circuit-Maintenance-Parser Docs](https://circuit-maintenance-parser.readthedocs.io/) website:
Full documentation for this library can be found over on the [Circuit-Maintenance-Parser Docs](https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/) website:

- [User Guide](https://circuit-maintenance-parser.readthedocs.io/en/latest/user/lib_overview/) - Overview, Using the Library, Getting Started.
- [Administrator Guide](https://circuit-maintenance-parser.readthedocs.io/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the Library.
- [Developer Guide](https://circuit-maintenance-parser.readthedocs.io/en/latest/dev/contributing/) - Extending the Library, Code Reference, Contribution Guide.
- [Release Notes / Changelog](https://circuit-maintenance-parser.readthedocs.io/en/latest/admin/release_notes/).
- [Frequently Asked Questions](https://circuit-maintenance-parser.readthedocs.io/en/latest/user/faq/).
- [User Guide](https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/user/lib_overview/) - Overview, Using the Library, Getting Started.
- [Administrator Guide](https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the Library.
- [Developer Guide](https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/dev/contributing/) - Extending the Library, Code Reference, Contribution Guide.
- [Release Notes / Changelog](https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/admin/release_notes/).
- [Frequently Asked Questions](https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/user/faq/).

## Context

Expand Down Expand Up @@ -307,11 +307,11 @@ The project is following Network to Code software development guidelines and is
- Pylint for additional static analysis.
- Unit and integration tests to ensure the library is working properly.

For more details, see the [Contributing Guide](https://circuit-maintenance-parser.readthedocs.io/en/latest/dev/contributing/) and [Development Environment Guide](https://circuit-maintenance-parser.readthedocs.io/en/latest/dev/dev_environment/).
For more details, see the [Contributing Guide](https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/dev/contributing/) and [Development Environment Guide](https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/dev/dev_environment/).

## Questions

For any questions or comments, please check the [FAQ](https://circuit-maintenance-parser.readthedocs.io/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#networktocode`), sign up [here](http://slack.networktocode.com/) if you don't have an account.
For any questions or comments, please check the [FAQ](https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#networktocode`), sign up [here](http://slack.networktocode.com/) if you don't have an account.

## License notes

Expand Down
1 change: 1 addition & 0 deletions changes/425.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed the documentation site: links now point to docs.networktocode.com instead of the retired Read the Docs Community project, and the theme logo and page edit links resolve correctly.
6 changes: 1 addition & 5 deletions circuit_maintenance_parser/parsers/apple.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,7 @@ def parse_subject(self, subject: str) -> List[Dict]:


class TextParserApple(Text):
"""Parse the plaintext content of an Apple notification.

Args:
Text (str): Plaintext message
"""
"""Parse the plaintext content of an Apple notification."""

def parse_text(self, text: str) -> List[Dict]:
"""Extract attributes from an Apple notification email.
Expand Down
8 changes: 4 additions & 4 deletions circuit_maintenance_parser/parsers/equinix.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,10 @@ def parse_subject(self, subject: str) -> List[Dict]:
"""Parse the Equinix Email subject for summary and status.

Args:
subject (str): subject of email
e.g. 'COMPLETED - Remedial Emergency Maintenance - SG Metro Area Network Maintenance - 04-APR-2026 [CHG0124084]'.
alternative format: 'Service Impacting - Remedial - Dark Fiber Activity - SG Metro Area - Network Maintenance - 03-MAY-2026 - CHG0125903'
older format: 'Scheduled software upgrade in metro connect platform-SG Metro Area Network Maintenance -19-OCT-2021 [5-212760022356]'
subject (str): subject of email, in one of the following formats:
e.g. 'COMPLETED - Remedial Emergency Maintenance - SG Metro Area Network Maintenance - 04-APR-2026 [CHG0124084]'.
alternative format: 'Service Impacting - Remedial - Dark Fiber Activity - SG Metro Area - Network Maintenance - 03-MAY-2026 - CHG0125903'
older format: 'Scheduled software upgrade in metro connect platform-SG Metro Area Network Maintenance -19-OCT-2021 [5-212760022356]'


Returns:
Expand Down
4 changes: 2 additions & 2 deletions circuit_maintenance_parser/parsers/flag.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ def parse_subject(self, subject: str) -> List[Dict]:
"""Parse the FLAG Email subject for maintenance ID and status.

Args:
subject (str): subject of email
e.g. 'FLAG | PE2025102750538 | Planned Event | Rescheduled'.
subject (str): subject of email,
e.g. 'FLAG | PE2025102750538 | Planned Event | Rescheduled'.


Returns:
Expand Down
4 changes: 2 additions & 2 deletions circuit_maintenance_parser/parsers/globalcloudxchange.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ def parse_subject(self, subject: str) -> List[Dict]:
"""Parse the Global Cloud Xchange Email subject for summary and status.

Args:
subject (str): subject of email
e.g. 'PE2024020844407 | Emergency | Service Advisory Notice | Span Loss Rectification | 12-Feb-2024 09:00 (GMT) - 12-Feb-2024 17:00 (GMT)'.
subject (str): subject of email,
e.g. 'PE2024020844407 | Emergency | Service Advisory Notice | Span Loss Rectification | 12-Feb-2024 09:00 (GMT) - 12-Feb-2024 17:00 (GMT)'.


Returns:
Expand Down
2 changes: 1 addition & 1 deletion circuit_maintenance_parser/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ def city_timezone(self, city: str) -> str:
raise ParserError("Timezone resolution not properly initalized.")


def convert_timezone(time_str):
def convert_timezone(time_str) -> datetime.datetime:
"""
Converts a string representing a date/time in the format 'MM/DD/YY HH:MM Timezone' to a datetime object in UTC.

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/release_notes/version_2.10.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document describes all new features and changes in the `2.10` release serie

- [#360](https://github.com/networktocode/circuit-maintenance-parser/issues/360) - Updated lxml to include version 6
- [#361](https://github.com/networktocode/circuit-maintenance-parser/issues/361) - Updated timezonefinder to v8.2.0
- [#345](https://github.com/networktocode/circuit_maintenance_parser/issues/345) - Updated minimum Python version to 3.10 and upgraded dependencies including pytest (9.0), pylint (4.0), towncrier (25.8), backoff (2.2), and type stubs
- [#345](https://github.com/networktocode/circuit-maintenance-parser/issues/345) - Updated minimum Python version to 3.10 and upgraded dependencies including pytest (9.0), pylint (4.0), towncrier (25.8), backoff (2.2), and type stubs

### Housekeeping

Expand Down
0 docs/images/networktocode_logo.svg → docs/assets/networktocode_logo.svg
View file
Open in desktop
File renamed without changes
5 changes: 2 additions & 3 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
dev_addr: "127.0.0.1:8001"
edit_uri: "edit/main/circuit-maintenance-parser/docs"
site_dir: "circuit-maintenance-parser/static/circuit-maintenance-parser/docs"
edit_uri: "edit/develop/docs"
site_name: "Circuit-Maintenance-Parser Documentation"
site_url: "https://circuit-maintenance-parser.readthedocs.io/en/latest/"
site_url: "https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/"
repo_url: "https://github.com/networktocode/circuit-maintenance-parser"
copyright: "Copyright &copy; The Authors"
theme:
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ version = "2.12.1b1"
description = "Python library to parse Circuit Maintenance notifications and return a structured data back"
authors = ["Network to Code, LLC <opensource@networktocode.com>"]
license = "Apache-2.0"
homepage = "https://circuit-maintenance-parser.readthedocs.io/"
homepage = "https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/"

@glennmatthews glennmatthews Aug 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do any of these fixes need to be additionally applied to the .cookiecutter.json file to make sure they don't get overwritten next time the package is rebaked?

@jvanderaa jvanderaa Sep 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jeffkala can you give me some insight here? From what I know and see we don't have this getting into cookiecutter today. I don't know the tool.

repository = "https://github.com/networktocode/circuit-maintenance-parser"
documentation = "https://circuit-maintenance-parser.readthedocs.io/"
documentation = "https://docs.networktocode.com/projects/circuit-maintenance-parser/en/latest/"
readme = "README.md"
keywords = ["parser", "circuit", "maintenance"]
classifiers = [
Expand Down
Loading