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.

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

docs: Added fix for building on Windows and resolved other build errors #2395

Merged
merged 7 commits into from
Mar 12, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
7 changes: 6 additions & 1 deletion doc/_sphinx/extensions/dart_domain.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ class DartdocDirective(SphinxDirective):
"symbol": directives.unchanged_required,
"package": directives.unchanged,
}
temp_file_path = ''

def __init__(self, name, arguments, options, content, lineno, content_offset, block_text, state,
state_machine):
Expand Down Expand Up @@ -165,15 +166,19 @@ def _scan_source_file_if_needed(self):
json_result = self._scan_source_file()
self.record['json'] = json_result
self.record['timestamp'] = source_last_modified_time
if os.path.isfile(self.temp_file_path):
os.remove(self.temp_file_path)

def _scan_source_file(self):
with tempfile.NamedTemporaryFile(mode='rt', suffix='json') as temp_file:
with tempfile.NamedTemporaryFile(mode='rt', suffix='.json', delete=False) as temp_file:
try:
self.temp_file_path = temp_file.name
subprocess.run(
['dartdoc_json', self.source_file, '--output', temp_file.name],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
check=True,
shell=True,
)
json_string = temp_file.read()
return self._extract_symbol(json_string)
Expand Down
1 change: 1 addition & 0 deletions doc/flame/flame.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,6 @@ Camera Component <camera_component.md>
Inputs <inputs/inputs.md>
Rendering <rendering/rendering.md>
Layout <layout/layout.md>
Overlays <overlays.md>
Other <other/other.md>
```
2 changes: 1 addition & 1 deletion doc/tutorials/platformer/step_7.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 7. Adding Menus

To add menus to the game, we will leverage Flame's built-in
[overlay](../../flame/game.md#flutter-widgets-and-game-instances) system.
[overlay](../../flame/overlays.md) system.


## Main Menu
Expand Down