Skip to content

Commit 99f235e

Browse files
committed
docs: minor changes in the generation
1 parent 0d95e01 commit 99f235e

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ jobs:
1919
uses: peaceiris/actions-gh-pages@v4
2020
with:
2121
github_token: ${{ secrets.GITHUB_TOKEN }}
22-
publish_dir: docs/_build/html
22+
publish_dir: docs/build/html

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
SPHINXOPTS ?=
22
SPHINXBUILD ?= sphinx-build
33
SOURCEDIR = .
4-
BUILDDIR = _build
4+
BUILDDIR = build
55
HELPERS = $(BUILDDIR)/hdl2bit $(BUILDDIR)/prj2bit $(BUILDDIR)/bitprog
66

77
help:

docs/conf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
# -- Project information -----------------------------------------------------
99

1010
project = 'PyFPGA'
11-
copyright = '2024, Rodrigo Alejandro Melo'
12-
author = 'Rodrigo Alejandro Melo'
11+
copyright = '2016-2024, PyFPGA Project'
12+
author = 'PyFPGA contributors'
1313

1414
# -- General configuration ---------------------------------------------------
1515

@@ -31,9 +31,9 @@
3131
'repositoy': ('https://github.com/PyFPGA/pyfpga/tree/main/%s', None)
3232
}
3333

34-
exclude_patterns = ['_build', 'wip']
34+
exclude_patterns = ['build']
3535

3636
# -- Options for HTML output -------------------------------------------------
3737

3838
html_theme = 'sphinx_rtd_theme'
39-
html_static_path = ['_static']
39+
html_static_path = ['images']

docs/helpers.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Helpers
44
hdl2bit
55
-------
66

7-
.. literalinclude:: _build/hdl2bit
7+
.. literalinclude:: build/hdl2bit
88

99
prj2bit
1010
-------
1111

12-
.. literalinclude:: _build/prj2bit
12+
.. literalinclude:: build/prj2bit
1313

1414
bitprog
1515
-------
1616

17-
.. literalinclude:: _build/bitprog
17+
.. literalinclude:: build/bitprog
File renamed without changes.
File renamed without changes.

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PyFPGA's documentation
22
======================
33

4-
.. image:: _static/logo.png
4+
.. image:: images/logo.png
55
:width: 200 px
66
:align: center
77
:target: https://github.com/PyFPGA/pyfpga

0 commit comments

Comments
 (0)