Skip to content

Commit 9dcead5

Browse files
committed
Update README about gh-pages deployment and remove unused Slack workflow
1 parent 0f1ac8e commit 9dcead5

File tree

2 files changed

+6
-56
lines changed

2 files changed

+6
-56
lines changed

.github/workflows/slack_notification.yaml

-21
This file was deleted.

README.md

+6-35
Original file line numberDiff line numberDiff line change
@@ -59,45 +59,16 @@ Finally to serve the website, you can run:
5959
python -m http.server --directory build/html
6060
```
6161

62+
### Viewing a forked repo GitHub Pages
6263

63-
### Adding Content to GitHub Pages
64-
65-
If you want to show the latest version of the docs on GitHub pages, build using then instructions above. Then from `pyscf-doc/source` run the following:
66-
67-
```bash
68-
make gh_pages_setup
69-
```
64+
The PySCF website is currently built and deployed to GitHub Pages any time a push is made to the master branch of the repository.
65+
The website is served out of the `docs/` directory of the `gh-pages` branch.
66+
This is all controlled by a GitHub Action in `.github/workflows/docs_deploy.yaml`.
67+
If you forked this repository and you want to view the website on your own GitHub Pages, make sure to enable Actions on your repository,
68+
because they are disabled in forks by default.
7069

7170
## How to Contribute
7271

7372
1. Add a rst file \"your\_method.rst\" in the [source/user](source/user/) directory in which one describes the basic theory and usage of the method. Reference \"user/your\_method.rst\" in the \"toctree\" section in [source/user.rst](source/user.rst).
7473
2. Add a rst file \"your\_module.rst\" in the [source/modules](source/modules/) directory in which one lists the examples and the member classes and functions of the module (the API doc is then generated by autodoc). (In the \"\_\_init\_\_.py\" file of each module, one should include a simple usage section. See [pyscf.dft.\_\_init\_\_.py](https://github.com/pyscf/pyscf/blob/master/pyscf/dft/__init__.py) as an example.) Reference \"your\_module.rst\" in the \"toctree\" section in [source/modules.rst](source/modules.rst).
7574
3. Optionally, one could also add a rst file \"your\_method\_develop.rst\" in the [source/develop](source/develop/) directory where one provides more detailed descriptions of the implementation and advanced guidelines for using and further development of the module. Reference \"your\_method\_develop.rst\" in [source/develop.rst](source/develop.rst).
76-
77-
78-
<!-- ## Adding Blog Posts
79-
80-
Create a new `.md` file in `pyscf-doc/source/posts` and add the following header (modified for your post):
81-
82-
```
83-
---
84-
blogpost: true
85-
date: February 1, 2021
86-
author: James Smith
87-
location: World
88-
category: Tutorial
89-
tags: HF, DFT, MCSCF
90-
language: English
91-
---
92-
```
93-
94-
If you want to write a post in `.rst` that's fine too! Just use the following in your header:
95-
96-
```
97-
:blogpost: true
98-
:date: Oct 10, 2020
99-
:author: Nabil Freij
100-
:location: World
101-
:category: Manual
102-
:language: English
103-
``` -->

0 commit comments

Comments
 (0)