Skip to content

Commit e11104e

Browse files
committed
tentative fix
1 parent 4973ee6 commit e11104e

File tree

6 files changed

+5
-17
lines changed

6 files changed

+5
-17
lines changed

docs/_ext/custom-robots.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,13 @@
66
def process_robots_txt(app, exception):
77
# Get the path to the robots.txt file
88
robots_file = os.path.join(app.outdir, "robots.txt")
9-
10-
# Read the contents of the robots.txt file
119
with open(robots_file) as f:
1210
contents = f.read()
1311

14-
# Modify the contents as needed
15-
# site_map = app.config['html_baseurl'] + app.config['version'] + app.config['language'] + 'sitemap.xml'
1612
site_map = "/".join(
1713
[app.config["html_baseurl"], app.config["language"], app.config["version"], "sitemap.xml"]
1814
).replace("//", "/")
19-
new_content = f"\nSitemap: {site_map}"
20-
contents += new_content
15+
contents += f"\nSitemap: {site_map}"
2116

2217
# Update the robots.txt file with the modified contents
2318
with open(robots_file, "w") as f:

docs/_templates/module.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,5 @@
3939

4040
.. rubric:: Inherited Common Usage
4141

42-
.. include:: ../_custom_autosummary/{{ fullname }}.rst
42+
.. include:: ../_custom_autosummary/{{ fullname }}.rst
43+
:optional:

docs/api/configuration.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ Manager and Helpers
1515
tidy3d.config.ConfigManager
1616
tidy3d.config.get_manager
1717
tidy3d.config.reload_config
18-
tidy3d.config.config
1918

2019
Legacy Compatibility
2120
--------------------
@@ -25,7 +24,6 @@ Legacy Compatibility
2524
:template: module.rst
2625

2726
tidy3d.config.LegacyConfigWrapper
28-
tidy3d.config.Env
2927
tidy3d.config.Environment
3028
tidy3d.config.EnvironmentConfig
3129

docs/api/constants.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Tidy3D Configuration
3535
:toctree: _autosummary/
3636
:template: module.rst
3737

38-
tidy3d.config.config
38+
tidy3d.config.ConfigManager
3939

4040
Default Absorber Parameters
4141
----------------------------

docs/configuration/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The location depends on your operating system:
4646
* - macOS / Linux
4747
- ``~/.config/tidy3d``
4848
* - Windows
49-
- ``C:\\Users\\<you>\\.config\\tidy3d``
49+
- ``C:\Users\<you>\.config\tidy3d``
5050

5151
You can override this by setting the ``TIDY3D_BASE_DIR`` environment variable
5252
*before* importing ``tidy3d``. When it is present, the config files are kept in

docs/configuration/migration.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,3 @@ Working Safely With Existing Scripts
4141
warnings.filterwarnings("ignore", category=DeprecationWarning)
4242

4343
- After updating your scripts, remove the filter so you notice future changes.
44-
45-
Need Help?
46-
----------
47-
48-
Reach out through the `Tidy3D Discussions board <https://github.com/flexcompute/tidy3d/discussions>`_
49-
or contact [email protected] if you hit any issues while upgrading.

0 commit comments

Comments
 (0)