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

Recover automatic documentation #62

Open
labra opened this issue Apr 10, 2021 · 1 comment
Open

Recover automatic documentation #62

labra opened this issue Apr 10, 2021 · 1 comment

Comments

@labra
Copy link
Member

labra commented Apr 10, 2021

Repair the documentation generation. I would like to try: https://scalameta.org/mdoc/.

@labra
Copy link
Member Author

labra commented Jun 6, 2021

We have almost done that. At this moment we changed the documentation generation system to use MDoc and it works very well.

There's only one pending problem which is the automatic deployment from github actions which is failing.

At this moment, if you want to deploy the documentation from your local machine, you can use:

GIT_USER=<GIT_USER> \
  CURRENT_BRANCH=master \
  USE_SSH=true \
  yarn run publish-gh-pages

But from github actions, the command is:

sbt docs/docusaurusPublishGhpages

and it fails with this message:

[info] running mdoc.Main                                                                           
info: Compiling 40 files to C:\src\utils\document\document-docs\target\mdoc                        
info: Compiled in 5,84s (0 errors)                                                                 
yarn install v1.22.4                                                                               
[1/4] Resolving packages...                                                                        
success Already up-to-date.                                                                        
Done in 0.56s.                                                                                     
Done in 0.56s.yarn run v1.22.4                                                                     
$ docusaurus-publish                                                                               
master                                                                                             
masterhttps://github.com/weso/document.git                                                         
https://github.com/weso/document.gitgenerate.js triggered...                                       
Version 9 of Highlight.js has reached EOL and is no longer supported.                              
Please upgrade or ask whatever dependency you are using to upgrade.                                
https://github.com/highlightjs/highlight.js/issues/2877                                            
sitemap.js triggered...                                                                            
sitemap.js triggered...Site built successfully. Generated files in 'build' folder.                 
Site built successfully. Generated files in 'build' folder.17860b969ab2c1a21be2a2abbe828e9777a5baa4
Cloning into 'document-gh-pages'...                                                                
Host key verification failed.                                                                      
fatal: Could not read from remote repository.                                                      
                                                                                                   
Please make sure you have the correct access rights                                                
17860b969ab2c1a21be2a2abbe828e9777a5baa4Error: git clone failed                                    
error Command failed with exit code 1.                                                             

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

No branches or pull requests

1 participant