Merge pull request #233 from pytorch/add-note-to-readme

Add deprecation notice to README

Author: svekars

CONTRIBUTING.md

@@ -2,10 +2,12 @@
 We want to make contributing to this project as easy and transparent as
 possible.
 
+> ⚠️ **IMPORTANT**: This package (`pytorch_sphinx_theme`) is no longer actively supported. Please submit all new pull requests to the [`pytorch_sphinx_theme2`](https://github.com/pytorch/pytorch_sphinx_theme/tree/pytorch_sphinx_theme2) branch.
+
 ## Pull Requests
 We actively welcome your pull requests.
 
-1. Fork the repo and create your branch from `master`.
+1. Fork the repo and create your branch from [`pytorch_sphinx_theme2`](https://github.com/pytorch/pytorch_sphinx_theme/tree/pytorch_sphinx_theme2).
 2. If you've added code that should be tested, add tests.
 3. If you've changed APIs, update the documentation.
 4. Ensure the test suite passes.
@@ -28,4 +30,4 @@ outlined on that page and do not file a public issue.
 
 ## License
 By contributing to pytorch_sphinx_theme, you agree that your contributions will be licensed
-under the LICENSE file in the root directory of this source tree.
+under the LICENSE file in the root directory of this source tree.

README.md

@@ -1,5 +1,7 @@
 # PyTorch Sphinx Theme
 
+> ⚠️ **DEPRECATION NOTICE**: This package (`pytorch_sphinx_theme`) is no longer actively supported. We are now actively working on `pytorch_sphinx_theme2` (see the [`pytorch_sphinx_theme2`](https://github.com/pytorch/pytorch_sphinx_theme/tree/pytorch_sphinx_theme2) branch in this repo). All new contributions should be directed there. At some point, the `pytorch_sphinx_theme2` branch will be renamed to `main` and become the default branch.
+
 Sphinx theme for [PyTorch Docs](https://pytorch.org/docs/master/torch.html) and [PyTorch Tutorials](https://pytorch.org/tutorials) based on the [Read the Docs Sphinx Theme](https://sphinx-rtd-theme.readthedocs.io/en/latest).
 
 ## Local Development