Skip to content

Docs on conditional content #5420

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

Closed
agjohnson opened this issue Mar 7, 2019 · 9 comments
Closed

Docs on conditional content #5420

agjohnson opened this issue Mar 7, 2019 · 9 comments
Labels
Needed: documentation Documentation is required

Comments

@agjohnson
Copy link
Contributor

A common question we get is how to do conditional content with Sphinx. There are a few options for this:

We should document these two methods in a guide or perhaps even break out an author's guide to start some RTD independent content on Sphinx authoring.

@agjohnson agjohnson added the Needed: documentation Documentation is required label Mar 7, 2019
@agjohnson agjohnson added this to the Better user documentation milestone Mar 7, 2019
@agarwalrounak
Copy link
Contributor

agarwalrounak commented Mar 7, 2019

Hi @agjohnson ! I think the issue #4603 deals with the same thing.
#4603 (comment)

@agarwalrounak
Copy link
Contributor

I have asked to work on that issue and I can include one more description under "How to have conditional content in your documentation" :

  • Using ifconfig directive to make conditional content

@stsewd
Copy link
Member

stsewd commented Mar 7, 2019

I think the issue #4603 deals with the same thing.

@agarwalrounak yes, they are related. Probably they can be addressed in the same PR

@agarwalrounak
Copy link
Contributor

@stsewd Sure, I will send a PR soon.

@stale
Copy link

stale bot commented Apr 22, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Apr 22, 2019
@dojutsu-user
Copy link
Member

Still valid bot.

@stale stale bot removed the Status: stale Issue will be considered inactive soon label Apr 22, 2019
@stale
Copy link

stale bot commented Jun 6, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Jun 6, 2019
@dojutsu-user dojutsu-user removed the Status: stale Issue will be considered inactive soon label Jun 6, 2019
@humitos
Copy link
Member

humitos commented Jun 6, 2019

I'm closing this one in favor of #4603

@humitos humitos closed this as completed Jun 6, 2019
@stsewd
Copy link
Member

stsewd commented Jun 6, 2019

We should update the other issue to include the other methods that are mentioned here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

5 participants