Skip to content

docs: Generate functions pages #15160

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs: Generate functions pages #15160

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
9 changes: 6 additions & 3 deletions docs/refman/generatormd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
ObjectType.ELEMENTARY: 'elementary',
ObjectType.BUILTIN: 'builtin',
ObjectType.MODULE: 'module',
ObjectType.FUNCTIONS: 'functions',
ObjectType.RETURNED: 'returned',
}

Expand Down Expand Up @@ -299,7 +300,7 @@ def _write_object(self, obj: Object) -> None:

def _write_functions(self) -> None:
data = {'functions': [self._gen_func_or_method(x) for x in self.functions]}
self._write_template(data, 'root.functions')
self._write_template(data, f'root.{_OBJ_ID_MAP[ObjectType.FUNCTIONS]}')

def _root_refman_docs(self) -> None:
def gen_obj_links(objs: T.List[Object]) -> T.List[T.Dict[str, str]]:
Expand Down Expand Up @@ -330,6 +331,7 @@ def gen_obj_links(objs: T.List[Object]) -> T.List[T.Dict[str, str]]:
self._write_template(data, 'root')
self._write_template({**dummy, 'name': 'Elementary types'}, f'root.{_OBJ_ID_MAP[ObjectType.ELEMENTARY]}', 'dummy')
self._write_template({**dummy, 'name': 'Builtin objects'}, f'root.{_OBJ_ID_MAP[ObjectType.BUILTIN]}', 'dummy')
self._write_functions()
self._write_template({**dummy, 'name': 'Returned objects'}, f'root.{_OBJ_ID_MAP[ObjectType.RETURNED]}', 'dummy')

if self.enable_modules:
Expand All @@ -339,7 +341,8 @@ def gen_obj_links(objs: T.List[Object]) -> T.List[T.Dict[str, str]]:
def generate(self) -> None:
mlog.log('Generating markdown files...')
with mlog.nested():
self._write_functions()
for fun in self.functions:
self._write_template(self._gen_func_or_method(fun), f'root.{_OBJ_ID_MAP[ObjectType.FUNCTIONS]}.{fun.name}', 'func')
for obj in self.objects:
if not self.enable_modules and (obj.obj_type == ObjectType.MODULE or obj.defined_by_module is not None):
continue
Expand Down Expand Up @@ -383,7 +386,7 @@ def _generate_link_def(self) -> None:
data[f'{obj.name}.{m.name}'] = f'{obj_file}#{obj.name}{m.name}'

# Functions
funcs_file = self._gen_filename('root.functions', extension='html')
funcs_file = self._gen_filename(f'root.{_OBJ_ID_MAP[ObjectType.FUNCTIONS]}', extension='html')
for fn in self.functions:
data[fn.name] = f'{funcs_file}#{fn.name}'

Expand Down
3 changes: 2 additions & 1 deletion docs/refman/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ class ObjectType(Enum):
ELEMENTARY = 0
BUILTIN = 1
MODULE = 2
RETURNED = 3
FUNCTIONS = 3
RETURNED = 4

@dataclass
class Object(NamedObject, FetureCheck):
Expand Down