Skip to content

Commit

Permalink
📝 Improve and Update documentation (#450)
Browse files Browse the repository at this point in the history
## Description

This PR improves the documentation by updating the year in the
copyright, updating a link to an external documentation and making the
MQT logo clickable.

All changes are taken from the PR cda-tum/mqt-core#589.

## Checklist:

<!---
This checklist serves as a reminder of a couple of things that ensure
your pull request will be merged swiftly.
-->

- [x] The pull request only contains commits that are related to it.
- [x] I have added appropriate tests and documentation.
- [x] I have made sure that all CI jobs on GitHub pass.
- [x] The pull request introduces no new warnings and follows the
project's style guidelines.
  • Loading branch information
ystade authored May 2, 2024
1 parent 5257159 commit 8fb3317
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Chair for Design Automation, Technical University of Munich
Copyright (c) 2024 Chair for Design Automation, Technical University of Munich

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@
[![codecov](https://img.shields.io/codecov/c/github/cda-tum/mqt-qmap?style=flat-square&logo=codecov)](https://codecov.io/gh/cda-tum/mqt-qmap)

<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt-qmap/main/docs/source/_static/mqt_light.png" width="60%">
<img src="https://raw.githubusercontent.com/cda-tum/mqt-qmap/main/docs/source/_static/mqt_dark.png" width="60%">
</picture>
</p>
<a href="https://mqt.readthedocs.io">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mqt-qmap/main/docs/source/_static/mqt_light.png" width="60%">
<img src="https://raw.githubusercontent.com/cda-tum/mqt-qmap/main/docs/source/_static/mqt_dark.png" width="60%">
</picture>
</a>
</p>

# MQT QMAP - A tool for Quantum Circuit Compilation

Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
project = "QMAP"
author = "Lukas Burgholzer"
language = "en"
project_copyright = "Chair for Design Automation, Technical University of Munich"
project_copyright = "2024, Chair for Design Automation, Technical University of Munich"

master_doc = "index"

Expand Down Expand Up @@ -73,7 +73,7 @@
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"typing_extensions": ("https://typing-extensions.readthedocs.io/en/latest/", None),
"qiskit": ("https://qiskit.org/documentation/", None),
"qiskit": ("https://docs.quantum.ibm.com/api/qiskit/", None),
"mqt": ("https://mqt.readthedocs.io/en/latest/", None),
"core": ("https://mqt.readthedocs.io/projects/core/en/latest/", None),
"ddsim": ("https://mqt.readthedocs.io/projects/ddsim/en/latest/", None),
Expand Down

0 comments on commit 8fb3317

Please sign in to comment.