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

Is it possible to control file naming? #121

Closed
jerriep opened this issue Jan 13, 2016 · 3 comments
Closed

Is it possible to control file naming? #121

jerriep opened this issue Jan 13, 2016 · 3 comments

Comments

@jerriep
Copy link

jerriep commented Jan 13, 2016

I am using docfx for generate the documentation for the Auth0 .NET SDK and have set up and automated build process with AppVeyor.

I have managed to generate the documentation with docfx automatically as part of the build pipeline, and after the build has been completed I want to upload the generated documentation to an Amazon S3 bucket.

In order to do that I need to define the generated documentation output as a build artifact in Appveyor. It seems that AppVeyor uploads their build artifacts to Google Storage, but Google Storage seems to have a problem with some of the file names generated by docfx for generic types which contains the ` character.

So I wonder if there is any way to tell docfx to not use the ` character for those filenames, but instead something else like a tilde (~) for example?

image

@vicancy
Copy link
Contributor

vicancy commented Jan 19, 2016

docfx will support renaming YAML files generated by docfx metadata in v1.4. v1.4 is now in preview stage and published to https://www.myget.org/feed/Packages/docfx-dev. It will be officially published to nuget after next week. In v1.4, you can have your own script to rename the generated YAML file before calling docfx build.

@jerriep
Copy link
Author

jerriep commented Jan 19, 2016

That sounds great, thanks @vicancy

@vicancy
Copy link
Contributor

vicancy commented Feb 1, 2016

v1.4 released to nuget

@vicancy vicancy closed this as completed Feb 1, 2016
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

2 participants