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

Docusaurus build and push commands do not copy *.css files from subdirectories of website/static. #942

Closed
ghost opened this issue Sep 4, 2018 · 4 comments
Assignees

Comments

@ghost
Copy link

ghost commented Sep 4, 2018

🐛 Bug Report

yarn run build and publish-gh-pages do not copy *.css files from our website/static/api directory that contains Doxygen-generated API docs into website/build. Is this intentional? All the other files, hundreds of them in a deep directory structure, are copied fine, but these two CSS files are ignored.

Have you read the Contributing Guidelines on issues?

yes

To Reproduce

  1. create a subdirectory of website/static, e.g., website/static/api
  2. put a few html and css files in there. Ideally run Doxygen to generate a documentation tree in static/api.
  3. run the build command, the

Expected behavior

I expected all files in all subdirectories of website/static to be copied into the corresponding subdirectores of website/build. Is this a correct assumption? Should I put Doxygen-generated files under website/pages instead?

bash-3.2$ diff ~/api.files ~/build.files
26d25
< doxygen.css
54d52
< tabs.css

Reproducible Demo

this is a private Facebookincubator repo at this time.

@ghost
Copy link
Author

ghost commented Sep 4, 2018

Using doxygen to view the site locally with 'npm start' finds the .css files. The Doxygen-generated tree in website/static is rendered correctly.

@JoelMarcey
Copy link
Contributor

I am working with @mvm3k now on this.

@JoelMarcey JoelMarcey self-assigned this Sep 4, 2018
@JoelMarcey
Copy link
Contributor

After chatting with @mvm3k - I believe we just needed to use the separateCSS option for siteConfig.js as described here: https://docusaurus.io/docs/en/site-config#optional-fields

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

@mvm3k is testing it now.

He made a good point that we should probably add something about Doxygen integration at a higher level of our docs where this setting could be crucial for Docusaurus.

@JoelMarcey
Copy link
Contributor

This worked. 🎉

We still have a bug where files starting with _ are are not getting built/published. Will look into that.

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