Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixing docs warnings #35

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixing docs warnings #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
#
# SPDX-License-Identifier: Apache-2.0

sphinx:
fail_on_warning: true

name: gf180mu-pdk-docs
channels:
- defaults
Expand Down
3 changes: 1 addition & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ docs: build display

.ONESHELL:
install-theme:
@cd docs/
@rm -rf sphinx_f4pga_theme
@rm -rf sphinx_f4pga_theme docs/sphinx_f4pga_theme
@git clone $(theme_link)
@cd sphinx_f4pga_theme
@python setup.py install
Expand Down
6 changes: 3 additions & 3 deletions docs/IPs/ips.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

************
IPs / Macros
************
***************
IPs and Macros
***************

.. toctree::
:maxdepth: 3
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2022 Efabless Corporation
# Copyright 2022 GlobalFoundries PDK Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
8 changes: 4 additions & 4 deletions docs/analog/model_parameters/LV/LV_2_5.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ where
Vth0 is the measured or simulated threshold voltage obtained using the max Gm method at Vd = 0.05V. For 6.0V native NMOS, Vth0 is measured and simulated at Vd=0.1V. Vth1 is the simulated threshold voltage obtained using the BSIM equation. These two values may have a difference.

2.5.1 nfet_03v3 and pfet_03v3 (3.3V)
..................................
........................................

.. csv-table::
:file: tables_clear/19_mos_3p3.csv


2.5.2 NMOS 3p3 SAB PMOS 3p3 SAB
...............................
.....................................

.. csv-table::
:file: tables_clear/20_MOS_3p3_SAB.csv
Expand All @@ -40,7 +40,7 @@ where
- pfet_03v3_dss SAB Length on Drain side SAB DOP: 1.78um, Source Side SAB SOP: 0.48um

2.5.3 nfet_06v0 and pfet_06v0 (6V)
................................
......................................

.. csv-table::
:file: tables_clear/21_mos_6p0.csv
Expand All @@ -52,7 +52,7 @@ where
- pfet_06v0_dss Length of SAB on Drain side : 2.78um, Length of SAB on Source side: 0.28um

2.5.4 nfet_06v0 and pfet_06v0 (5V)
................................
......................................

.. csv-table::
:file: tables_clear/22_mos_6p0_1.csv
Expand Down
10 changes: 5 additions & 5 deletions docs/analog/model_parameters/LV/LV_8_1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
===========

8.1.1 nfet_03v3 (3.3V)
.....................
............................

8.1.1.1 CV - Characteristics
""""""""""""""""""""""""""""
Expand Down Expand Up @@ -89,7 +89,7 @@
:alt: I/f Noise - Characteristics

8.1.2 pfet_03v3 (3.3V)
.....................
..........................

8.1.2.1 CV - Characteristics
""""""""""""""""""""""""""""
Expand Down Expand Up @@ -176,7 +176,7 @@
:alt: I/f Noise - Characteristics

8.1.3 nfet_06v0 (6.0V)
.....................
..........................

8.1.3.1 CV - Characteristics
""""""""""""""""""""""""""""
Expand Down Expand Up @@ -217,7 +217,7 @@
:alt: I/f Noise - Characteristics

8.1.4 pfet_06v0 (6.0V)
.....................
..........................

8.1.4.1 CV - Characteristics
""""""""""""""""""""""""""""
Expand Down Expand Up @@ -264,7 +264,7 @@
:alt: I/f Noise - Characteristics

8.1.5 nfet_06v0_nvt (6.0V)
.........................
..............................

8.1.5.1 IV - Characteristics
""""""""""""""""""""""""""""
Expand Down
22 changes: 14 additions & 8 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@
import docutils
import os
import re
# import sys
import sys
# sys.path.insert(0, os.path.abspath('.'))
sys.path.append(os.path.abspath('open-source-pdks/docs'))


# -- Project information -----------------------------------------------------
Expand All @@ -59,6 +60,11 @@
'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
'sphinx.ext.todo',
'sphinx_pdk_roles',
]

suppress_warnings = [
'autosectionlabel.*',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -106,11 +112,6 @@
# Usually you set "language" from the command line for these cases.
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
Expand All @@ -120,6 +121,11 @@
'venv',
'Thumbs.db',
'.DS_Store',
'.vscode',
'IPs/**/code-of-conduct.rst',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you just drop the IPs bit? IE Just **/code-of-conduct.rst?

'IPs/**/contributing.rst',
'digital/**/code-of-conduct.rst',
'digital/**/contributing.rst',
]

# The name of the Pygments (syntax highlighting) style to use.
Expand Down Expand Up @@ -169,15 +175,15 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ['_static','open-source-pdks/docs/_static']


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('gf180mcu-pdk', 'GlobalFoundries 0.18UM PDK Documentation',
('gf180mcu-pdk', 'GlobalFoundries 180nm PDK Documentation',
[author], 1)
]

Expand Down
11 changes: 2 additions & 9 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
Welcome to GlobalFoundries 0.18UM 3.3V/(5V)6V MCU PDK's documentation!
****************************************************************************

.. include:: common.inc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this remove is needed any more?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicate thus produce warning.


.. toctree::
:hidden:
Expand All @@ -13,7 +12,7 @@ Welcome to GlobalFoundries 0.18UM 3.3V/(5V)6V MCU PDK's documentation!
IPs/ips
physical_verification/design_man

open-source-pdks/index
open-source-pdks/docs/index

.. warning::
This documentation is currently a **work in progress**.
Expand All @@ -22,11 +21,5 @@ Welcome to GlobalFoundries 0.18UM 3.3V/(5V)6V MCU PDK's documentation!
:align: center
:alt: GlobalFoundries PDK Logo Image.


Current Status -- |current-status|
==================================

.. include:: status
:start-after: current_status_text

.. include:: status.rst

2 changes: 1 addition & 1 deletion docs/open-source-pdks
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
../third_party/open-source-pdks/docs
../third_party/open-source-pdks
6 changes: 2 additions & 4 deletions docs/status.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
.. include:: common.inc

Current Status -- |current-status|
==================================

.. current_status_text
.. include:: common.inc

.. warning::
Google and GlobalFoundries are currently treating the current content as an **experimental preview** / **alpha release**.
Expand All @@ -12,5 +10,5 @@ While the GF180 process node and the PDK from which this open source release was

Google, GlobalFoundries and our partners are currently doing internal validation and test designs, including silicon validation or the released data and plan to publish these results.

The PDK will be tagged with a production version when ready to do production design, see the ":ref:`Versioning Information`" section for a full description of the version numbering scheme.
The PDK will be tagged with a production version when ready to do production design, see the ":ref:`Versioning`" section for a full description of the version numbering scheme.