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

Jazzy produces filenames with unsupported characters on Windows for Swift Operators #361

Closed
RndmTsk opened this issue Nov 13, 2015 · 3 comments
Assignees
Labels

Comments

@RndmTsk
Copy link

RndmTsk commented Nov 13, 2015

Operators such as "public func +=<K, V> (inout left: [K:V], right: [K:V]) { ... }" produce file names that include unsupported characters on Windows machines (i.e. an IIS server).

Example filename: +=(::).html

@jpsim jpsim added the bug label Nov 24, 2015
@RndmTsk
Copy link
Author

RndmTsk commented Nov 25, 2015

Here is a list of unsupported characters: https://support.microsoft.com/en-us/kb/177506

@pigeondotdev
Copy link
Contributor

#558 needs to be reviewed but this issue is a little irrelevant/out of date now. Closing and will continue the conversation in that PR.

@SDGGiesbrecht
Copy link
Contributor

The configuration option use_safe_filenames and the corresponding flag --use-safe-filenames are now available. Until 0.7.4 is released, you can build and run from source (in your project directory):

git clone https://github.com/realm/jazzy
cd jazzy
bundle install
cd ..
jazzy/bin/jazzy --use-safe-filenames
rm -rf jazzy

Any other flags you normally use (such as --clean) can be added to the second last line.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants