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

Sphinx workflow #475

Merged
merged 26 commits into from
Mar 19, 2024
Merged

Sphinx workflow #475

merged 26 commits into from
Mar 19, 2024

Conversation

engrosamaali91
Copy link
Contributor

In order to setup a GitHub Workflow we require gh-pages in fastsurfer repository where html pages will be deployed.

@engrosamaali91 engrosamaali91 marked this pull request as draft March 7, 2024 16:51
Copy link
Member

@dkuegler dkuegler left a comment

Choose a reason for hiding this comment

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

Importantly, move not copy.

@dkuegler
Copy link
Member

dkuegler commented Mar 14, 2024

  1. rebase on upstream
  2. Docker and Singularity Files:
    1. Remove the files in doc/overview
    2. Update the Links in other Markdown files
  3. Examples etc.
    1. rename FASTSURFER_EXAMPLES.md to EXAMPLES.md (and other FASTSURFER_* files)
    2. update the links to examples etc. in all Markdown files (examples moved from README.md to doc/overview/FASTSURFER_EXAMPLES.md)

Copy link
Member

@dkuegler dkuegler left a comment

Choose a reason for hiding this comment

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

As stated in PR.

@dkuegler dkuegler requested a review from m-reuter March 14, 2024 16:32
@dkuegler dkuegler force-pushed the sphinx_workflow branch 2 times, most recently from 5938dea to 94f68cc Compare March 15, 2024 18:17
@dkuegler
Copy link
Member

dkuegler commented Mar 15, 2024

We are finally at a stage where the build works and the error is because of something completely different. In this case, the download_checkpoints.py script is broken, because it was not updated by #467 .

@m-reuter
Copy link
Member

m-reuter commented Mar 15, 2024

What still needs to be done here:

  • Import of download_checkpoints fails as it gets ImportError: cannot import name 'VINN_AXI' from 'FastSurferCNN.utils.checkpoint' and other similar things. This needs to be fixed in dev (@agirodi ), then we rebase here.
  • doc/overview/FASTSURFER_EXAMPLES.md etc still exist and seem to be duplicates, check, merge (if necessary) and delete duplicates. FASTSURFER_EXAMPLES should be deleted , EXAMPLES.md kept, same with the other two.
  • also doc/overview/README.md and the other md files replicate content of /README.md? So this means updating both files all the time? We need to discuss a solution for this.
  • directory /doc/_static needs to be created (with .gitkeep empty file in it) as sphinx is looking for it.
  • no idea what to do with the futures formatting warnings: concurrent.futures._base.Executor.map:15: WARNING: Inline emphasis start-string without end-string. , anyone? Why is sphinx even looking at those as they are not part of our project?

@dkuegler
Copy link
Member

* [ ]  no idea what to do with the futures formatting warnings: `concurrent.futures._base.Executor.map:15: WARNING: Inline emphasis start-string without end-string.` , anyone? Why is sphinx even looking at those as they are not part of our project?

That is even a private module of concurrent.futures.

@dkuegler
Copy link
Member

Maybe we can fix this warning with the autodoc_mock_imports directive?

Add a list of modules in the autodoc_mock_imports to prevent import errors to halt the building process when some external dependencies are not importable at build time.

engrosamaali91 and others added 9 commits March 18, 2024 17:04
Remaining rst files added, README.md file split
Fixing label duplication warnings and other warnings
Requested changes applied
pyproject.toml and doc.yml file added to trigger sphinx workflow
Added all READMD.md files
fix optional dependencies
Add myst parser
add sklearn, skimage, torchvision in pyproject.toml
Fix all warm import
@m-reuter m-reuter marked this pull request as ready for review March 19, 2024 19:50
@m-reuter m-reuter merged commit 026eac3 into Deep-MI:dev Mar 19, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants