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

Add mappings to support conversion of contents other than Mapdl commands #46

Open
anspcoinaud opened this issue May 22, 2023 · 5 comments
Labels
enhancement New features or code improvements

Comments

@anspcoinaud
Copy link

📝 Description of the feature

After testing conversion of other XML-Docbook contents, the conversion is successful but empty. It means the content types to be converted are ignored because not mapped to any output type.
My guess is we have to map every xml tag (here in blue) to a rst style for the output to be correct:
image

If possible, a .MD output would be preferable.

💡 Steps for implementing the feature

No response

🔗 Useful links and references

No response

@anspcoinaud anspcoinaud added the enhancement New features or code improvements label May 22, 2023
@anspcoinaud
Copy link
Author

@clatapie don't hesitate to ask for more details or anything that would help you along the way 😊

@anspcoinaud
Copy link
Author

@clatapie hey :) Did you have a chance to have a look a this? I'm still figuring out how to migrate docbook contents to either RST or MD. Thanks!

@clatapie
Copy link
Collaborator

Hi @anspcoinaud!

In my opinion, this need might fit better in the creation of another project instead of adding directly this functionality in this package but it's an open discussion! I have the feeling that, as its goal is not the same one of this package, the difficulty on how to use it might increase.
Let me ping @RobPasMue, @germa89 and @MaxJPRey for visibility on that question.

In the meantime, let me contact you to talk about the way we could process.

@germa89
Copy link
Contributor

germa89 commented Jun 12, 2023

As far as I understood, PyDita is a general purpose library. Hence we should not implement any logic specific to any documentation. We should provide PyDita as a dependency where you can build your own library to treat your own documentation set.

Having said that, PyDita should provide the tools to create this library, allowing custom rules, etc. If anything is needed for that purpose, please @anspcoinaud let us know.

@anspcoinaud
Copy link
Author

Thanks @germa89
We are actively looking for a way to convert Docbook contents into either RST or MD, so that these contents can be migrated to the Developer Portal (which does not support docbook). I initially contacted Camille because it looks like what she did partly covers that need.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

No branches or pull requests

3 participants