docs: minor changes in the generation

PyFPGA · Aug 31, 2024 · 99f235e · 99f235e
1 parent 0d95e01
commit 99f235e
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 10 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -19,4 +19,4 @@ jobs:
       uses: peaceiris/actions-gh-pages@v4
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: docs/_build/html
+        publish_dir: docs/build/html
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,7 +1,7 @@
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
-BUILDDIR      = _build
+BUILDDIR      = build
 HELPERS       = $(BUILDDIR)/hdl2bit $(BUILDDIR)/prj2bit $(BUILDDIR)/bitprog
 
 help:

diff --git a/docs/conf.py b/docs/conf.py
@@ -8,8 +8,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'PyFPGA'
-copyright = '2024, Rodrigo Alejandro Melo'
-author = 'Rodrigo Alejandro Melo'
+copyright = '2016-2024, PyFPGA Project'
+author = 'PyFPGA contributors'
 
 # -- General configuration ---------------------------------------------------
 
@@ -31,9 +31,9 @@
    'repositoy': ('https://github.com/PyFPGA/pyfpga/tree/main/%s', None)
 }
 
-exclude_patterns = ['_build', 'wip']
+exclude_patterns = ['build']
 
 # -- Options for HTML output -------------------------------------------------
 
 html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
+html_static_path = ['images']
diff --git a/docs/helpers.rst b/docs/helpers.rst
@@ -4,14 +4,14 @@ Helpers
 hdl2bit
 -------
 
-.. literalinclude:: _build/hdl2bit
+.. literalinclude:: build/hdl2bit
 
 prj2bit
 -------
 
-.. literalinclude:: _build/prj2bit
+.. literalinclude:: build/prj2bit
 
 bitprog
 -------
 
-.. literalinclude:: _build/bitprog
+.. literalinclude:: build/bitprog
diff --git a/docs/_static/logo.png → docs/images/logo.png b/docs/_static/logo.png → docs/images/logo.png
diff --git a/docs/_static/schema.png → docs/images/schema.png b/docs/_static/schema.png → docs/images/schema.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,7 +1,7 @@
 PyFPGA's documentation
 ======================
 
-.. image:: _static/logo.png
+.. image:: images/logo.png
    :width: 200 px
    :align: center
    :target: https://github.com/PyFPGA/pyfpga