Skip to content

Commit 5e08a36

Browse files
committed
Formatting fixes
1 parent 9f596bb commit 5e08a36

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

_posts/articles/2019-04-20-github-pages-python-sphinx.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,20 +65,21 @@ When GitHub sees a `.nojekyll` file, it serves the root `index.html` file. Read
6565
## Create a "docsource" or "docsrc" folder for the source files
6666

6767
Now, in the root of your repository, you can create a source folder for your doc builds:
68-
* If you're working with code and docs in the same repo, you can name the folder `docsource` or `docsrc`.
69-
* If your repo is for only documentation, you can name the folder `source`.
68+
69+
- If you're working with code and docs in the same repo, you can name the folder `docsource` or `docsrc`.
70+
- If your repo is for only documentation, you can name the folder `source`.
7071

7172
Next, make sure that your `conf.py` file has been set up with these source and destination directories. The Sphinx documentation has a good [Configuration section](http://www.sphinx-doc.org/en/master/usage/configuration.html).
7273

7374
## Make sure you can still build Sphinx locally for reviews
7475

7576
Here's another pro tip I found while browsing [Issues in the Sphinx repository itself](https://github.com/sphinx-doc/sphinx/issues/3382#issuecomment-470772316). Since you want to keep the source and output separate, but still be able to both publish on GitHub Pages and preview builds locally, you can add an option to your `Makefile` to do both.
7677

77-
```
78-
github:
79-
@make html
80-
@cp -a _build/html/. ../docs
81-
```
78+
```
79+
github:
80+
@make html
81+
@cp -a _build/html/. ../docs
82+
```
8283

8384
Now you can run `make github` from the doc source directory to generate a local preview and move the docs where GitHub wants to serve them from.
8485

0 commit comments

Comments
 (0)