Skip to content
Closed
Show file tree
Hide file tree
Changes from all 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
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,4 @@ src/*.egg-info
venv
cov.xml
.coverage.*
*.psycache
__pycache__
18 changes: 18 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for adding this. Please could you add the usual licence/copyright header (with appropriate year).

Copy link
Member

Choose a reason for hiding this comment

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

Also, please add a comment saying it builds the html versions of all of the docs.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm working on the proposed changes quite late. There have been huge updates on this Makefile. I'll remove my suggested changes since the new version from master is much better.

all: developer_guide reference_guide user_guide
.PHONY: developer_guide reference_guide user_guide

developer_guide:
make -C developer_guide html SPHINXOPTS="-W --keep-going"

reference_guide:
make -C reference_guide html SPHINXOPTS="-W --keep-going"
Copy link
Member

Choose a reason for hiding this comment

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

Unfortunately this gives:

build finished with problems, 2 warnings (with warnings treated as errors).
make[1]: *** [Makefile:19: html] Error 1
make[1]: Leaving directory '/home/me/Projects/PSyclone/doc/reference_guide'
make: *** [Makefile:9: reference_guide] Error 2

Possibly the simplest thing to do is not to "treat warnings as errors" for the Reference Guide.

Copy link
Collaborator Author

@schreiberx schreiberx Jul 16, 2025

Choose a reason for hiding this comment

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

I'm working on the proposed changes quite late. There have been huge updates on this Makefile. I'll remove my suggested changes since the new version from master is much better.


user_guide:
make -C user_guide html SPHINXOPTS="-W --keep-going"

clean:
make -C developer_guide clean
make -C reference_guide allclean
make -C user_guide clean

4 changes: 2 additions & 2 deletions src/psyclone/psyir/nodes/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -197,5 +197,5 @@
'OMPScheduleClause',
'OMPFirstprivateClause',
'OMPSharedClause',
'OMPDependClause'
]
'OMPDependClause',
Copy link
Member

Choose a reason for hiding this comment

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

Please revert (since there's no functional change to this file).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

OK.

]
Loading
Loading