From fd2577f2bcb32dbc9f0dc920854549f43040178c Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Tue, 15 Feb 2022 03:32:28 +0100 Subject: [PATCH 1/7] requirements: update theme source Signed-off-by: Unai Martinez-Corral --- requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 2fb5bb8..1f86dcb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ -sphinx==3.0.4 -http://github.com/SymbiFlow/sphinx_materialdesign_theme/archive/master.zip#sphinx_symbiflow_theme +Sphinx==3.0.4 +http://github.com/SymbiFlow/sphinx_symbiflow_theme/archive/master.zip#sphinx-symbiflow-theme http://github.com/SymbiFlow/sphinx-verilog-domain/archive/master.zip#sphinx-verilog-domain From 1662b9ae6ec7415b9b362b183f35ce071d809b8b Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Tue, 15 Feb 2022 03:53:04 +0100 Subject: [PATCH 2/7] conf: update theme options; 's/SymbiFlow/F4PGA/' Signed-off-by: Unai Martinez-Corral --- source/conf.py | 68 ++++++++------------------------------------------ 1 file changed, 10 insertions(+), 58 deletions(-) diff --git a/source/conf.py b/source/conf.py index 9680142..65acc79 100644 --- a/source/conf.py +++ b/source/conf.py @@ -9,10 +9,10 @@ import sys, os # -- General configuration ----------------------------------------------------- -project = u'SymbiFlow' -basic_filename = u'symbiflow-docs' -authors = u'SymbiFlow' -copyright = authors + u', 2019' +project = 'F4PGA' +basic_filename = 'f4pga-docs' +authors = 'F4PGA Authors' +copyright = f'{authors}, 2019 - 2022' version = '' release = '' # The full version, including alpha/beta/rc tags. @@ -48,64 +48,16 @@ rst_prolog = """ # -- Options for HTML output --------------------------------------------------- -html_theme = "sphinx_symbiflow_theme" +html_show_sourcelink = True + +html_theme = 'sphinx_symbiflow_theme' html_theme_options = { - # Specify a list of menu in Header. - # Tuples forms: - # ('Name', 'external url or path of pages in the document', boolean, 'icon name') - # - # Third argument: - # True indicates an external link. - # False indicates path of pages in the document. - # - # Fourth argument: - # Specify the icon name. - # For details see link. - # https://material.io/icons/ - 'header_links' : [ - ('Home', 'index', False, 'home'), - ("Website", "https://symbiflow.github.io", True, 'launch'), - ("GitHub", "https://github.com/SymbiFlow", True, 'code') - ], - - # Customize css colors. - # For details see link. - # https://getmdl.io/customize/index.html - # - # Values: amber, blue, brown, cyan deep_orange, deep_purple, green, grey, indigo, light_blue, - # light_green, lime, orange, pink, purple, red, teal, yellow(Default: indigo) - 'primary_color': 'deep_purple', - # Values: Same as primary_color. (Default: pink) - 'accent_color': 'purple', - - # Customize layout. - # For details see link. - # https://getmdl.io/components/index.html#layout-section - 'fixed_drawer': True, - 'fixed_header': True, - 'header_waterfall': True, - 'header_scroll': False, - - # Render title in header. - # Values: True, False (Default: False) - 'show_header_title': False, - # Render title in drawer. - # Values: True, False (Default: True) - 'show_drawer_title': True, - # Render footer. - # Values: True, False (Default: True) - 'show_footer': True + 'repo_name': 'chipsalliance/f4pga-docs', + 'github_url' : 'https://github.com/chipsalliance/f4pga-docs', + 'globaltoc_collapse': True, } -html_title = project - -html_last_updated_fmt = today_fmt - -html_show_sphinx = False - -htmlhelp_basename = basic_filename - # -- Options for LaTeX output -------------------------------------------------- latex_documents = [ From 00fc2217dd7d1ebcfb8d0c7cde9cd027b0f562a2 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral <38422348+umarcor@users.noreply.github.com> Date: Wed, 16 Feb 2022 11:42:40 +0100 Subject: [PATCH 3/7] ci: set cron daily Signed-off-by: Unai Martinez-Corral --- .github/workflows/Doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/Doc.yml b/.github/workflows/Doc.yml index d13fe3c..73ae367 100644 --- a/.github/workflows/Doc.yml +++ b/.github/workflows/Doc.yml @@ -4,7 +4,7 @@ on: pull_request: push: schedule: - - cron: '0 0 * * 4' + - cron: '0 0 * * *' workflow_dispatch: jobs: From 7c48a0db490e82a8a24f93a1e06ace3e1c762593 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Mon, 21 Feb 2022 16:20:16 +0100 Subject: [PATCH 4/7] theme: use variant 'chips' Signed-off-by: Unai Martinez-Corral --- requirements.txt | 2 +- source/conf.py | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 1f86dcb..2a38f86 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ Sphinx==3.0.4 -http://github.com/SymbiFlow/sphinx_symbiflow_theme/archive/master.zip#sphinx-symbiflow-theme +http://github.com/SymbiFlow/sphinx_symbiflow_theme/archive/chips.zip#sphinx-symbiflow-theme http://github.com/SymbiFlow/sphinx-verilog-domain/archive/master.zip#sphinx-verilog-domain diff --git a/source/conf.py b/source/conf.py index 65acc79..7035546 100644 --- a/source/conf.py +++ b/source/conf.py @@ -56,6 +56,8 @@ html_theme_options = { 'repo_name': 'chipsalliance/f4pga-docs', 'github_url' : 'https://github.com/chipsalliance/f4pga-docs', 'globaltoc_collapse': True, + 'color_primary': 'indigo', + 'color_accent': 'blue', } # -- Options for LaTeX output -------------------------------------------------- From b97ef856e83a596f90d779e84309f11dc779f19f Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Mon, 21 Feb 2022 16:25:13 +0100 Subject: [PATCH 5/7] readthedocs: quote python version Signed-off-by: Unai Martinez-Corral --- readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readthedocs.yml b/readthedocs.yml index 9fa1d8d..9c71e97 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -14,7 +14,7 @@ formats: [] # Optionally set the version of Python and requirements required to build your docs python: - version: 3.7 + version: "3.7" conda: environment: environment.yml From f092b2fa9e09b0a86332e85e962897db783829b2 Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Thu, 10 Feb 2022 03:42:47 +0100 Subject: [PATCH 6/7] conf: add logo and favicon; use '_static' Signed-off-by: Unai Martinez-Corral --- source/_static/favicon.svg | 1 + source/{ => _static}/images/EDA.svg | 0 source/{ => _static}/images/parts.svg | 0 .../{ => _static}/images/toolchain-flow.svg | 0 source/_static/logo.svg | 66 +++++++++++++++++++ source/conf.py | 6 ++ source/introduction.rst | 4 +- source/toolchain-desc/design-flow.rst | 2 +- 8 files changed, 76 insertions(+), 3 deletions(-) create mode 100644 source/_static/favicon.svg rename source/{ => _static}/images/EDA.svg (100%) rename source/{ => _static}/images/parts.svg (100%) rename source/{ => _static}/images/toolchain-flow.svg (100%) create mode 100644 source/_static/logo.svg diff --git a/source/_static/favicon.svg b/source/_static/favicon.svg new file mode 100644 index 0000000..5535f19 --- /dev/null +++ b/source/_static/favicon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/source/images/EDA.svg b/source/_static/images/EDA.svg similarity index 100% rename from source/images/EDA.svg rename to source/_static/images/EDA.svg diff --git a/source/images/parts.svg b/source/_static/images/parts.svg similarity index 100% rename from source/images/parts.svg rename to source/_static/images/parts.svg diff --git a/source/images/toolchain-flow.svg b/source/_static/images/toolchain-flow.svg similarity index 100% rename from source/images/toolchain-flow.svg rename to source/_static/images/toolchain-flow.svg diff --git a/source/_static/logo.svg b/source/_static/logo.svg new file mode 100644 index 0000000..29b511d --- /dev/null +++ b/source/_static/logo.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + + + diff --git a/source/conf.py b/source/conf.py index 7035546..9bee510 100644 --- a/source/conf.py +++ b/source/conf.py @@ -4,6 +4,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html import sys, os +from pathlib import Path #sys.path.insert(0, os.path.abspath('.')) @@ -60,6 +61,11 @@ html_theme_options = { 'color_accent': 'blue', } +html_static_path = ['_static'] + +html_logo = str(Path(html_static_path[0]) / 'logo.svg') +html_favicon = str(Path(html_static_path[0]) / 'favicon.svg') + # -- Options for LaTeX output -------------------------------------------------- latex_documents = [ diff --git a/source/introduction.rst b/source/introduction.rst index e8fe353..32d5ca3 100644 --- a/source/introduction.rst +++ b/source/introduction.rst @@ -25,7 +25,7 @@ all the necessary components for an end-to-end flow. This pertains both to ASIC and FPGA workflows, although SymbiFlow focuses on the latter (some parts of SymbiFlow will also be useful in the former). -.. figure:: images/EDA.svg +.. figure:: _static/images/EDA.svg Project structure ----------------- @@ -48,7 +48,7 @@ collaborating projects targeting different FPGAs - :doc:`Project X-Ray `_ for Lattice iCE40 and :doc:`Project Trellis ` for Lattice ECP5 FPGAs. -.. figure:: images/parts.svg +.. figure:: _static/images/parts.svg Current status of bitstream documentation ----------------------------------------- diff --git a/source/toolchain-desc/design-flow.rst b/source/toolchain-desc/design-flow.rst index d17f337..4bc3efb 100644 --- a/source/toolchain-desc/design-flow.rst +++ b/source/toolchain-desc/design-flow.rst @@ -15,7 +15,7 @@ SymbiFlow uses different programs to create the bitstream and is responsible for their proper integration. The procedure of converting Verilog file into the bitstream is described in the next sections. -.. figure:: ../images/toolchain-flow.svg +.. figure:: ../_static/images/toolchain-flow.svg :align: center Symbiflow Toolchain design flow From 284a0a966741216437603761fafa517857c0882a Mon Sep 17 00:00:00 2001 From: Unai Martinez-Corral Date: Mon, 21 Feb 2022 17:47:36 +0100 Subject: [PATCH 7/7] relicense to Apache-2.0 Signed-off-by: Unai Martinez-Corral --- COPYING | 13 ---- LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 202 insertions(+), 13 deletions(-) delete mode 100644 COPYING create mode 100644 LICENSE diff --git a/COPYING b/COPYING deleted file mode 100644 index 1acf555..0000000 --- a/COPYING +++ /dev/null @@ -1,13 +0,0 @@ -Copyright (C) 2019 The SymbiFLow Authors - -Permission to use, copy, modify, and/or distribute this software for any -purpose with or without fee is hereby granted, provided that the above -copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License.